twitterapi-io-client 1.0.2 → 1.0.3

package/README.md

@@ -86,6 +86,13 @@ const accountInfo = await client.getUserProfileAbout("jorvixsky")
 | Get Article | `GET /twitter/article` | ✅ Supported | `client.tweets.getArticle(articleId)` |
 | Advanced Search | `GET /twitter/search` | ✅ Supported | `client.tweets.searchTweets(query, queryType?, cursor?)` |
 
+### ✅ Stream Endpoint
+
+| Endpoint | Method | Status | Notes |
+|----------|--------|--------|-------|
+| Add User to Monitor | `POST /oapi/x_user_stream/add_user_to_monitor_tweet` | ✅ Supported | `client.stream.addUserToMonitor(xUserName)` |
+| Remove User from Monitor | `POST /oapi/x_user_stream/remove_user_from_monitor_tweet` | ✅ Supported | `client.stream.removeUserFromMonitor(xUserName)` |
+
 ## Not Supported Endpoints
 
 The following endpoint categories are **not yet implemented**:
@@ -115,11 +122,6 @@ The following endpoint categories are **not yet implemented**:
 - `POST /oapi/webhook/filter/update` - Update Webhook/Websocket Tweet Filter Rule
 - `DELETE /oapi/webhook/filter/delete` - Delete Webhook/Websocket Tweet Filter Rule
 
-### ❌ Stream Endpoint
-
-- `POST /oapi/stream/add` - Add a twitter user to monitor his tweets
-- `POST /oapi/stream/remove` - Remove a user from monitor list
-
 ### ❌ Deprecated Endpoints
 
 The following endpoints are marked as deprecated in the API documentation and are not implemented:
@@ -136,8 +138,8 @@ The following endpoints are marked as deprecated in the API documentation and ar
 
 ## Implementation Status Summary
 
-- **Fully Supported**: 27 endpoints (10 User endpoints + 2 List endpoints + 1 My endpoint + 5 Communities endpoints + 1 Trend endpoint + 1 Spaces endpoint + 7 Tweet endpoints)
-- **Not Implemented**: ~16+ endpoints across multiple categories
+- **Fully Supported**: 29 endpoints (10 User endpoints + 2 List endpoints + 1 My endpoint + 5 Communities endpoints + 1 Trend endpoint + 1 Spaces endpoint + 7 Tweet endpoints + 2 Stream endpoints)
+- **Not Implemented**: ~14+ endpoints across multiple categories
 
 ## Contributing
 
@@ -147,3 +149,6 @@ Contributions are welcome! If you'd like to add support for additional endpoints
 
 For detailed API documentation, visit: [https://docs.twitterapi.io](https://docs.twitterapi.io)
 
+## Support the project
+
+If you need to create your twitterapi-io account and you want to support this client to help me mantain it and make your implementation easier for you, you can do so by using this [affiliate link](https://twitterapi.io/?ref=jordi666). 

package/dist/client.d.ts

@@ -6,6 +6,7 @@ import { CommunitiesApi } from "./resources/communities";
 import { TrendsApi } from "./resources/trends";
 import { SpacesApi } from "./resources/spaces";
 import { TweetsApi } from "./resources/tweets";
+import { StreamApi } from "./resources/stream";
 export interface TwitterAPIIOClientOptions extends HttpClientOptions {
 }
 export declare class TwitterAPIIOClient {
@@ -16,5 +17,6 @@ export declare class TwitterAPIIOClient {
     readonly trends: TrendsApi;
     readonly spaces: SpacesApi;
     readonly tweets: TweetsApi;
+    readonly stream: StreamApi;
     constructor(options: TwitterAPIIOClientOptions);
 }

package/dist/client.js

@@ -9,6 +9,7 @@ const communities_1 = require("./resources/communities");
 const trends_1 = require("./resources/trends");
 const spaces_1 = require("./resources/spaces");
 const tweets_1 = require("./resources/tweets");
+const stream_1 = require("./resources/stream");
 class TwitterAPIIOClient {
     users;
     myEndpoint;
@@ -17,6 +18,7 @@ class TwitterAPIIOClient {
     trends;
     spaces;
     tweets;
+    stream;
     constructor(options) {
         const http = new httpClient_1.HttpClient(options);
         this.users = new users_1.UsersApi(http);
@@ -26,6 +28,7 @@ class TwitterAPIIOClient {
         this.trends = new trends_1.TrendsApi(http);
         this.spaces = new spaces_1.SpacesApi(http);
         this.tweets = new tweets_1.TweetsApi(http);
+        this.stream = new stream_1.StreamApi(http);
     }
 }
 exports.TwitterAPIIOClient = TwitterAPIIOClient;

package/dist/resources/stream.d.ts

@@ -0,0 +1,8 @@
+import type { HttpClient } from "../httpClient";
+import type { StreamResponse } from "../types/stream";
+export declare class StreamApi {
+    private http;
+    constructor(http: HttpClient);
+    addUserToMonitor(xUserName: string): Promise<StreamResponse>;
+    removeUserFromMonitor(xUserName: string): Promise<StreamResponse>;
+}

package/dist/resources/stream.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamApi = void 0;
+class StreamApi {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async addUserToMonitor(xUserName) {
+        const body = {
+            x_user_name: xUserName,
+        };
+        return this.http.request("/oapi/x_user_stream/add_user_to_monitor_tweet", {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(body),
+        });
+    }
+    async removeUserFromMonitor(xUserName) {
+        const body = {
+            x_user_name: xUserName,
+        };
+        return this.http.request("/oapi/x_user_stream/remove_user_from_monitor_tweet", {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(body),
+        });
+    }
+}
+exports.StreamApi = StreamApi;

package/dist/types/index.d.ts

@@ -5,3 +5,4 @@ export * from "./spaces";
 export * from "./trends";
 export * from "./list";
 export * from "./myEndpoint";
+export * from "./stream";

package/dist/types/index.js

@@ -21,3 +21,4 @@ __exportStar(require("./spaces"), exports);
 __exportStar(require("./trends"), exports);
 __exportStar(require("./list"), exports);
 __exportStar(require("./myEndpoint"), exports);
+__exportStar(require("./stream"), exports);

package/dist/types/stream.d.ts

@@ -0,0 +1,10 @@
+export interface AddUserToMonitorRequest {
+    x_user_name: string;
+}
+export interface RemoveUserFromMonitorRequest {
+    x_user_name: string;
+}
+export interface StreamResponse {
+    status: "success" | "error";
+    msg: string;
+}

package/dist/types/stream.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "twitterapi-io-client",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A TypeScript client library for the TwitterAPI.io API",
   "author": "jorvixsky",
   "license": "MIT",
@@ -29,7 +29,8 @@
     "test:communities": "vitest run test/communities.test.ts",
     "test:trends": "vitest run test/trends.test.ts",
     "test:spaces": "vitest run test/spaces.test.ts",
-    "test:tweets": "vitest run test/tweets.test.ts"
+    "test:tweets": "vitest run test/tweets.test.ts",
+    "test:stream": "vitest run test/stream.test.ts"
   },
   "devDependencies": {
     "@types/node": "24.10.0",