@pipedream/twitter 0.3.11 → 1.0.0

package/dist/actions/follow-user/follow-user.d.ts

@@ -0,0 +1,255 @@
+import { getUserId } from "../../common/methods.js";
+import { FollowUserParams } from "../../common/types/requestParams.js";
+declare const _default: import("@pipedream/types").Action<{
+    getUserId: typeof getUserId;
+}, {
+    app: import("@pipedream/types").App<{
+        _getAuthHeader(config: import("../../common/types/requestParams.js").HttpRequestParams): Promise<import("oauth-1.0a").Header>;
+        _getBaseUrl(): "https://api.twitter.com/2";
+        _httpRequest({ $, ...args }: import("../../common/types/requestParams.js").HttpRequestParams): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").TwitterEntity>>;
+        _paginatedRequest({ maxResults, maxPerPage, params, ...args }: import("../../common/types/requestParams.js").PaginatedRequestParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").TwitterEntity>>;
+        addUserToList({ listId, ...args }: import("../../common/types/requestParams.js").AddUserToListParams): Promise<object>;
+        createTweet(args: import("../../common/types/requestParams.js").CreateTweetParams): Promise<object>;
+        deleteTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").DeleteTweetParams): Promise<object>;
+        followUser(args: FollowUserParams): Promise<object>;
+        getListTweets({ listId, ...args }: import("../../common/types/requestParams.js").GetListTweetsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+        getTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").GetTweetParams): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+        getAuthenticatedUserId(): Promise<string>;
+        getUserLikedTweets({ userId, ...args }: import("../../common/types/requestParams.js").GetUserLikedTweetParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+        getUserOwnedLists({ userId, ...args }: import("../../common/types/requestParams.js").GetUserOwnedListsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").List>>;
+        getUserFollowedLists({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowedListsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").List>>;
+        getUserMentions({ userId, ...args }: import("../../common/types/requestParams.js").GetUserMentionsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+        getUserTweets({ userId, ...args }: import("../../common/types/requestParams.js").GetUserTweetsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+        getUserByUsername(username: string): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").User>>;
+        getUser({ userId, ...args }: import("../../common/types/requestParams.js").GetUserParams): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").User>>;
+        likeTweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
+        getUserFollowers({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").User>>;
+        getUserFollowing({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").User>>;
+        retweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
+        searchTweets(args: import("../../common/types/requestParams.js").SearchTweetsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+        unfollowUser({ userId, ...args }: import("../../common/types/requestParams.js").UnfollowUserParams): Promise<object>;
+        unlikeTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").UnlikeTweetParams): Promise<object>;
+    }, {
+        maxResults: {
+            type: string;
+            label: string;
+            description: string;
+            optional: boolean;
+        };
+        listId: {
+            type: string;
+            label: string;
+            description: string;
+            options(): Promise<{
+                label: string;
+                value: string;
+            }[]>;
+        };
+        userNameOrId: {
+            type: string;
+            label: string;
+            description: string;
+            optional: boolean;
+            default: string;
+        };
+        tweetId: {
+            type: string;
+            label: string;
+            description: string;
+        };
+        query: {
+            type: string;
+            label: string;
+            description: string;
+        };
+        listExpansions: {
+            type: string;
+            label: string;
+            optional: boolean;
+            description: string;
+            options: string[];
+        };
+        tweetExpansions: {
+            type: string;
+            label: string;
+            optional: boolean;
+            description: string;
+            options: string[];
+        };
+        userExpansions: {
+            type: string;
+            label: string;
+            optional: boolean;
+            description: string;
+            options: string[];
+        };
+        listFields: {
+            type: string;
+            label: string;
+            description: string;
+            optional: boolean;
+            options: string[];
+        };
+        mediaFields: {
+            type: string;
+            label: string;
+            description: string;
+            optional: boolean;
+            options: string[];
+        };
+        placeFields: {
+            type: string;
+            label: string;
+            description: string;
+            optional: boolean;
+            options: string[];
+        };
+        pollFields: {
+            type: string;
+            label: string;
+            description: string;
+            optional: boolean;
+            options: string[];
+        };
+        tweetFields: {
+            type: string;
+            label: string;
+            description: string;
+            optional: boolean;
+            options: string[];
+        };
+        userFields: {
+            type: string;
+            label: string;
+            description: string;
+            optional: boolean;
+            options: string[];
+        };
+    }>;
+    userNameOrId: {
+        propDefinition: (string | import("@pipedream/types").App<{
+            _getAuthHeader(config: import("../../common/types/requestParams.js").HttpRequestParams): Promise<import("oauth-1.0a").Header>;
+            _getBaseUrl(): "https://api.twitter.com/2";
+            _httpRequest({ $, ...args }: import("../../common/types/requestParams.js").HttpRequestParams): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").TwitterEntity>>;
+            _paginatedRequest({ maxResults, maxPerPage, params, ...args }: import("../../common/types/requestParams.js").PaginatedRequestParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").TwitterEntity>>;
+            addUserToList({ listId, ...args }: import("../../common/types/requestParams.js").AddUserToListParams): Promise<object>;
+            createTweet(args: import("../../common/types/requestParams.js").CreateTweetParams): Promise<object>;
+            deleteTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").DeleteTweetParams): Promise<object>;
+            followUser(args: FollowUserParams): Promise<object>;
+            getListTweets({ listId, ...args }: import("../../common/types/requestParams.js").GetListTweetsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").GetTweetParams): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getAuthenticatedUserId(): Promise<string>;
+            getUserLikedTweets({ userId, ...args }: import("../../common/types/requestParams.js").GetUserLikedTweetParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getUserOwnedLists({ userId, ...args }: import("../../common/types/requestParams.js").GetUserOwnedListsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").List>>;
+            getUserFollowedLists({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowedListsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").List>>;
+            getUserMentions({ userId, ...args }: import("../../common/types/requestParams.js").GetUserMentionsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getUserTweets({ userId, ...args }: import("../../common/types/requestParams.js").GetUserTweetsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getUserByUsername(username: string): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").User>>;
+            getUser({ userId, ...args }: import("../../common/types/requestParams.js").GetUserParams): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").User>>;
+            likeTweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
+            getUserFollowers({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").User>>;
+            getUserFollowing({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").User>>;
+            retweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
+            searchTweets(args: import("../../common/types/requestParams.js").SearchTweetsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            unfollowUser({ userId, ...args }: import("../../common/types/requestParams.js").UnfollowUserParams): Promise<object>;
+            unlikeTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").UnlikeTweetParams): Promise<object>;
+        }, {
+            maxResults: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+            };
+            listId: {
+                type: string;
+                label: string;
+                description: string;
+                options(): Promise<{
+                    label: string;
+                    value: string;
+                }[]>;
+            };
+            userNameOrId: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                default: string;
+            };
+            tweetId: {
+                type: string;
+                label: string;
+                description: string;
+            };
+            query: {
+                type: string;
+                label: string;
+                description: string;
+            };
+            listExpansions: {
+                type: string;
+                label: string;
+                optional: boolean;
+                description: string;
+                options: string[];
+            };
+            tweetExpansions: {
+                type: string;
+                label: string;
+                optional: boolean;
+                description: string;
+                options: string[];
+            };
+            userExpansions: {
+                type: string;
+                label: string;
+                optional: boolean;
+                description: string;
+                options: string[];
+            };
+            listFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            mediaFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            placeFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            pollFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            tweetFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            userFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+        }>)[];
+    };
+}>;
+export default _default;

package/dist/actions/follow-user/follow-user.mjs

@@ -0,0 +1,37 @@
+import app from "../../app/twitter.app.mjs";
+import { defineAction } from "@pipedream/types";
+import { getUserId } from "../../common/methods.mjs";
+const DOCS_LINK = "https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/post-users-source_user_id-following";
+export default defineAction({
+    key: "twitter-follow-user",
+    name: "Follow User",
+    description: `Follow a user. [See docs here](${DOCS_LINK})`,
+    version: "1.0.0",
+    type: "action",
+    props: {
+        app,
+        userNameOrId: {
+            propDefinition: [
+                app,
+                "userNameOrId",
+            ],
+        },
+    },
+    methods: {
+        getUserId,
+    },
+    async run({ $ }) {
+        const userId = await this.getUserId();
+        const params = {
+            $,
+            data: {
+                target_user_id: userId,
+            },
+        };
+        const response = await this.app.followUser(params);
+        $.export("$summary", `Successfully ${response.following
+            ? "followed"
+            : "requested to follow"} user`);
+        return response;
+    },
+});