@pipedream/twitter 0.3.11 → 1.0.0

package/dist/actions/create-tweet/create-tweet.d.ts

@@ -0,0 +1,163 @@
+import { CreateTweetParams } from "../../common/types/requestParams.js";
+declare const _default: import("@pipedream/types").Action<unknown, {
+    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: CreateTweetParams): Promise<object>;
+        deleteTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").DeleteTweetParams): Promise<object>;
+        followUser(args: import("../../common/types/requestParams.js").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[];
+        };
+    }>;
+    text: {
+        type: string;
+        label: string;
+        description: string;
+        optional: boolean;
+    };
+    inReplyToTweetId: {
+        type: string;
+        label: string;
+        description: string;
+        optional: boolean;
+    };
+    excludeReplyUserIds: {
+        type: string;
+        label: string;
+        description: string;
+        optional: boolean;
+    };
+    mediaIds: {
+        type: string;
+        label: string;
+        description: string;
+        optional: boolean;
+    };
+    taggedUserIds: {
+        type: string;
+        label: string;
+        description: string;
+        optional: boolean;
+    };
+    placeId: {
+        type: string;
+        label: string;
+        description: string;
+        optional: boolean;
+    };
+}>;
+export default _default;

package/dist/actions/create-tweet/create-tweet.mjs

@@ -0,0 +1,78 @@
+import app from "../../app/twitter.app.mjs";
+import { defineAction } from "@pipedream/types";
+const DOCS_LINK = "https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/post-tweets";
+export default defineAction({
+    key: "twitter-create-tweet",
+    name: "Create Tweet",
+    description: `Create a new tweet. [See docs here](${DOCS_LINK})`,
+    version: "1.0.0",
+    type: "action",
+    props: {
+        app,
+        text: {
+            type: "string",
+            label: "Text",
+            description: "Text of the Tweet being created. Required if `Media IDs` is not set.",
+            optional: true,
+        },
+        inReplyToTweetId: {
+            type: "string",
+            label: "In Reply To Tweet (ID)",
+            description: "Tweet ID of the Tweet being replied to. Please note that this prop needs to be set if `Exclude Reply User IDs` is also set.",
+            optional: true,
+        },
+        excludeReplyUserIds: {
+            type: "string[]",
+            label: "Exclude Reply User IDs",
+            description: "A list of User IDs to be excluded from the reply Tweet thus removing a user from a thread.",
+            optional: true,
+        },
+        mediaIds: {
+            type: "string[]",
+            label: "Media IDs",
+            description: "A list of Media IDs being attached to the Tweet. This is only required if `Tagged User IDs` is set.",
+            optional: true,
+        },
+        taggedUserIds: {
+            type: "string[]",
+            label: "Tagged User IDs",
+            description: "A list of User IDs being tagged in the Tweet with Media. If the user you're tagging doesn't have photo-tagging enabled, their names won't show up in the list of tagged users even though the Tweet is successfully created.",
+            optional: true,
+        },
+        placeId: {
+            type: "string",
+            label: "Place ID",
+            description: "Place ID being attached to the Tweet for geo location.",
+            optional: true,
+        },
+    },
+    async run({ $ }) {
+        const { text, inReplyToTweetId, excludeReplyUserIds, mediaIds, placeId, taggedUserIds, } = this;
+        const params = {
+            $,
+            data: {
+                text,
+                ...((inReplyToTweetId || excludeReplyUserIds) && {
+                    reply: {
+                        exclude_reply_user_ids: excludeReplyUserIds,
+                        in_reply_to_tweet_id: inReplyToTweetId,
+                    },
+                }),
+                ...((mediaIds || taggedUserIds) && {
+                    media: {
+                        media_ids: mediaIds,
+                        tagged_user_ids: taggedUserIds,
+                    },
+                }),
+                ...(placeId && {
+                    geo: {
+                        place_id: placeId,
+                    },
+                }),
+            },
+        };
+        const response = await this.app.createTweet(params);
+        $.export("$summary", "Successfully posted tweet");
+        return response;
+    },
+});

package/dist/actions/delete-tweet/delete-tweet.d.ts

@@ -0,0 +1,252 @@
+import { DeleteTweetParams } from "../../common/types/requestParams.js";
+declare const _default: import("@pipedream/types").Action<unknown, {
+    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 }: DeleteTweetParams): Promise<object>;
+        followUser(args: import("../../common/types/requestParams.js").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[];
+        };
+    }>;
+    tweetId: {
+        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 }: DeleteTweetParams): Promise<object>;
+            followUser(args: import("../../common/types/requestParams.js").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/delete-tweet/delete-tweet.mjs

@@ -0,0 +1,28 @@
+import app from "../../app/twitter.app.mjs";
+import { defineAction } from "@pipedream/types";
+const DOCS_LINK = "https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/delete-tweets-id";
+export default defineAction({
+    key: "twitter-delete-tweet",
+    name: "Delete Tweet",
+    description: `Remove a posted tweet. [See docs here](${DOCS_LINK})`,
+    version: "1.0.0",
+    type: "action",
+    props: {
+        app,
+        tweetId: {
+            propDefinition: [
+                app,
+                "tweetId",
+            ],
+        },
+    },
+    async run({ $ }) {
+        const params = {
+            $,
+            tweetId: this.tweetId,
+        };
+        const response = await this.app.deleteTweet(params);
+        $.export("$summary", "Successfully deleted tweet");
+        return response;
+    },
+});