PostsClient

Cliente para operaciones con publicaciones

Este cliente proporciona métodos para interactuar con los endpoints de publicaciones de la X API. Se encarga de la autenticación, el formato de las solicitudes y el análisis de las respuestas para todas las operaciones relacionadas con las publicaciones.

​

Constructores

​

constructor

• new PostsClient(client): PostsClient

Crea una nueva instancia de PostsClient

​

Parámetros

Nombre	Tipo	Descripción
client	Client	La instancia principal del Client de X API

​

Devuelve

PostsClient

​

Definido en

posts/client.ts:789

​

Métodos

​

getInsights28hr

▸ getInsights28hr(tweetIds, granularity, requestedMetrics, options): Promise<Response>

Obtiene información de Publicaciones en un periodo de 28 horas Recupera las métricas de interacción de las Publicaciones especificadas durante las últimas 28 horas.

​

Parámetros

Nombre	Tipo	Descripción
tweetIds	any[]	Lista de PostIds para métricas de 28 h.
granularity	string	Granularidad de la respuesta de métricas.
requestedMetrics	any[]	Métricas solicitadas para la consulta histórica.
options	GetInsights28hrOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:842

▸ getInsights28hr(tweetIds, granularity, requestedMetrics, options?): Promise<Get2Insights28hrResponse>

​

Parámetros

Nombre	Tipo
tweetIds	any[]
granularity	string
requestedMetrics	any[]
options?	GetInsights28hrOptions

​

Devuelve

Promise<Get2Insights28hrResponse>

​

Definido en

posts/client.ts:863

---

​

getAnalytics

▸ getAnalytics(ids, endTime, startTime, granularity, options): Promise<Response>

Obtener métricas de Publicaciones
Recupera datos de métricas para las Publicaciones especificadas dentro de un intervalo de tiempo determinado.

​

Parámetros

Nombre	Tipo	Descripción
ids	any[]	Una lista de ID de Publicación separada por comas. Se permiten hasta 100 en una sola solicitud.
endTime	string	YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el final del intervalo de tiempo.
startTime	string	YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el inicio del intervalo de tiempo.
granularity	string	La granularidad de los resultados del recuento de búsquedas.
options	GetAnalyticsOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:1052

▸ getAnalytics(ids, endTime, startTime, granularity, options?): Promise<Analytics>

​

Parámetros

Nombre	Tipo
ids	any[]
endTime	string
startTime	string
granularity	string
options?	GetAnalyticsOptions

​

Devuelve

Promise<Analytics>

​

Definido en

posts/client.ts:1077

---

​

getReposts

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

Obtener Reposts
Recupera una lista de Publicaciones que hacen repost de una Publicación específica por su identificador.

​

Parámetros

Nombre	Tipo	Descripción
id	string	Un único ID de Publicación.
options	GetRepostsOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:1271

▸ getReposts(id, options?): Promise<Get2TweetsIdRetweetsResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetRepostsOptions

​

Devuelve

Promise<Get2TweetsIdRetweetsResponse>

​

Definido en

posts/client.ts:1284

---

​

searchRecent

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

Buscar publicaciones recientes
Obtiene publicaciones de los últimos 7 días que coinciden con una consulta de búsqueda.

​

Parámetros

Nombre	Tipo	Descripción
query	string	Una consulta/regla/filtro para hacer coincidir Publicaciones. Consulta https://t.co/rulelength para conocer la longitud máxima de la consulta.
options	SearchRecentOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:1559

▸ searchRecent(query, options?): Promise<Get2TweetsSearchRecentResponse>

​

Parámetros

Nombre	type
query	string
options?	SearchRecentOptions

​

Devuelve

Promise<Get2TweetsSearchRecentResponse>

​

Definido en

posts/client.ts:1572

---

​

searchAll

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

Buscar en todas las Publicaciones Obtiene Publicaciones del archivo completo que coinciden con una consulta de búsqueda.

​

Parámetros

Nombre	Tipo	Descripción
query	string	Una consulta/regla/filtro para encontrar Publicaciones coincidentes. Consulte https://t.co/rulelength para ver la longitud máxima permitida de la consulta.
options	SearchAllOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promise que se resuelve con la respuesta de la API, o el Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:1968

▸ searchAll(query, options?): Promise<Get2TweetsSearchAllResponse>

​

Parámetros

Nombre	type
query	string
options?	SearchAllOptions

​

Devuelve

Promise<Get2TweetsSearchAllResponse>

​

Definido en

posts/client.ts:1981

---

​

getByIds

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

Obtener Publicaciones por id
Obtiene los detalles de varias Publicaciones mediante sus id.

​

Parámetros

Nombre	Tipo	Descripción
ids	any[]	Una lista separada por comas de identificadores de Publicaciones. Se permiten hasta 100 en una única solicitud.
options	GetByIdsOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promise que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:2365

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

​

Parámetros

Nombre	Tipo
ids	any[]
options?	GetByIdsOptions

​

Devuelve

Promise<Get2TweetsResponse>

​

Definido en

posts/client.ts:2378

---

​

create

▸ create(body, options): Promise<Response>

Crear o editar una Publicación Crea una nueva Publicación para el usuario autenticado o edita una Publicación existente cuando se proporcionan edit_options.

​

Parámetros

Nombre	Tipo	Descripción
body	TweetCreateRequest	Cuerpo de la solicitud
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:2622

▸ create(body): Promise<TweetCreateResponse>

​

Parámetros

Nombre	Tipo
body	TweetCreateRequest

​

Devuelve

Promise<TweetCreateResponse>

​

Definido en

posts/client.ts:2633

---

​

getQuoted

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

Obtener publicaciones citadas
Devuelve una lista de publicaciones que citan una publicación específica por su identificador.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de una única Publicación.
options	GetQuotedOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:2718

▸ getQuoted(id, options?): Promise<Get2TweetsIdQuoteTweetsResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetQuotedOptions

​

Devuelve

Promise<Get2TweetsIdQuoteTweetsResponse>

​

Definido en

posts/client.ts:2731

---

​

getCountsRecent

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

Obtener el número de Publicaciones recientes Devuelve el número de Publicaciones de los últimos 7 días que coinciden con una consulta de búsqueda.

​

Parámetros

Nombre	Tipo	Descripción
query	string	Una consulta/regla/filtro para hacer coincidir Publicaciones. Consulta https://t.co/rulelength para identificar la longitud máxima de la consulta.
options	GetCountsRecentOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:3025

▸ getCountsRecent(query, options?): Promise<Get2TweetsCountsRecentResponse>

​

Parámetros

Nombre	Type
query	string
options?	GetCountsRecentOptions

​

Devuelve

Promise<Get2TweetsCountsRecentResponse>

​

Definido en

posts/client.ts:3038

---

​

hideReply

▸ hideReply(tweetId, options): Promise<Response>

Ocultar respuesta
Oculta o muestra una respuesta en una conversación que pertenece al usuario autenticado.

​

Parámetros

Nombre	Tipo	Descripción
tweetId	string	El identificador de la respuesta que deseas ocultar o dejar de ocultar.
options	HideReplyOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:3298

▸ hideReply(tweetId, options?): Promise<TweetHideResponse>

​

Parámetros

Nombre	Type
tweetId	string
options?	HideReplyOptions

​

Devuelve

Promise<TweetHideResponse>

​

Definido en

posts/client.ts:3311

---

​

getInsightsHistorical

▸ getInsightsHistorical(tweetIds, endTime, startTime, granularity, requestedMetrics, options): Promise<Response>

Obtén insights históricos sobre Publicaciones Recupera métricas de interacción históricas para las Publicaciones especificadas dentro de un intervalo de tiempo definido.

​

Parámetros

Nombre	Tipo	Descripción
tweetIds	any[]	Lista de PostIds para métricas históricas.
endTime	string	YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el final del rango de tiempo.
startTime	string	YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el inicio del rango de tiempo.
granularity	string	Granularidad de la respuesta de métricas.
requestedMetrics	any[]	Métricas solicitadas para la consulta histórica.
options	GetInsightsHistoricalOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promise que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:3435

▸ getInsightsHistorical(tweetIds, endTime, startTime, granularity, requestedMetrics, options?): Promise<Get2InsightsHistoricalResponse>

​

Parámetros

Nombre	Tipo
tweetIds	any[]
endTime	string
startTime	string
granularity	string
requestedMetrics	any[]
options?	GetInsightsHistoricalOptions

​

Devuelve

Promise<Get2InsightsHistoricalResponse>

​

Definido en

posts/client.ts:3464

---

​

getCountsAll

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

Obtener el número total de Publicaciones
Recupera la cantidad de Publicaciones que coinciden con una consulta de búsqueda en todo el archivo.

​

Parámetros

Nombre	Tipo	Descripción
query	string	Una consulta/regla/filtro para hacer coincidir con Publicaciones. Consulta https://t.co/rulelength para identificar la longitud máxima permitida de la consulta.
options	GetCountsAllOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promise que se resuelve con la respuesta de la API o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:3679

▸ getCountsAll(query, options?): Promise<Get2TweetsCountsAllResponse>

​

Parámetros

Nombre	Type
query	string
options?	GetCountsAllOptions

​

Devuelve

Promise<Get2TweetsCountsAllResponse>

​

Definido en

posts/client.ts:3692

---

​

getById

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

Obtener Publicación por ID Obtiene los detalles de una Publicación específica mediante su ID.

​

Parámetros

Nombre	Type	Descripción
id	string	Un único identificador de Publicación.
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:3952

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

​

Parámetros

Nombre	Tipo
id	string
options?	GetByIdOptions

​

Devuelve

Promise<Get2TweetsIdResponse>

​

Definido en

posts/client.ts:3965

---

​

delete

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

Eliminar Publicación Elimina una Publicación específica por su id, si es propiedad del usuario autenticado.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador de la Publicación que se va a eliminar.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:4202

▸ delete(id): Promise<TweetDeleteResponse>

​

Parámetros

Nombre	Tipo
id	string

​

Devuelve

Promise<TweetDeleteResponse>

​

Definido en

posts/client.ts:4215

---

​

getLikingUsers

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

Obtener usuarios que dieron “Me gusta” Recupera una lista de usuarios que dieron “Me gusta” a una Publicación específica por su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id de una sola Publicación.
options	GetLikingUsersOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:4306

▸ getLikingUsers(id, options?): Promise<Get2TweetsIdLikingUsersResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetLikingUsersOptions

​

Devuelve

Promise<Get2TweetsIdLikingUsersResponse>

​

Definido en

posts/client.ts:4319

---

​

getRepostedBy

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

Get Reposted by Recupera una lista de usuarios que han vuelto a publicar una Publicación específica a partir de su id.

​

Parámetros

Nombre	Tipo	Descripción
id	string	Un identificador único de una Publicación.
options	GetRepostedByOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

Promise que se resuelve con la respuesta de la API o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

posts/client.ts:4525

▸ getRepostedBy(id, options?): Promise<Get2TweetsIdRetweetedByResponse>

​

Parámetros

Nombre	Tipo
id	string
options?	GetRepostedByOptions

​

Devuelve

Promise<Get2TweetsIdRetweetedByResponse>

​

Definido en

posts/client.ts:4538