@pipedream/twitter 0.3.2 → 0.3.5

package/actions/add-user-to-list/add-user-to-list.mjs

@@ -0,0 +1,62 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-add-user-to-list",
+  name: "Add User To List",
+  description: "Add a member to a list. The authenticated user must own the list to be able to add members to it. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    twitter,
+    list: {
+      propDefinition: [
+        twitter,
+        "listSlug",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        twitter,
+        "userId",
+      ],
+      optional: true,
+    },
+    screenName: {
+      propDefinition: [
+        twitter,
+        "screenName",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      list,
+      userId,
+      screenName,
+    } = this;
+
+    if (!userId && !screenName) {
+      throw new Error("This action requires either User ID or Screen Name. Please enter one or the other above.");
+    }
+
+    const { screen_name: ownerScreenName } = await this.twitter.verifyCredentials({
+      $,
+    });
+
+    const params = {
+      slug: list,
+      ownerScreenName,
+    };
+    if (userId) params.userId = userId;
+    if (screenName) params.screenName = screenName;
+
+    const res = await this.twitter.addUserToList({
+      $,
+      ...params,
+    });
+
+    $.export("$summary", "User successfully added to the list");
+    return res;
+  },
+};

package/actions/advanced-search/advanced-search.mjs

@@ -0,0 +1,113 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-advanced-search",
+  name: "Advanced Search",
+  description: "Return Tweets that matches your search criteria. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets)",
+  version: "0.0.3",
+  type: "action",
+  props: {
+    db: "$.service.db",
+    twitter,
+    q: {
+      propDefinition: [
+        twitter,
+        "q",
+      ],
+    },
+    resultType: {
+      propDefinition: [
+        twitter,
+        "resultType",
+      ],
+    },
+    includeRetweets: {
+      propDefinition: [
+        twitter,
+        "includeRetweets",
+      ],
+    },
+    includeReplies: {
+      propDefinition: [
+        twitter,
+        "includeReplies",
+      ],
+    },
+    lang: {
+      propDefinition: [
+        twitter,
+        "lang",
+      ],
+    },
+    locale: {
+      propDefinition: [
+        twitter,
+        "locale",
+      ],
+    },
+    geocode: {
+      propDefinition: [
+        twitter,
+        "geocode",
+      ],
+    },
+    sinceId: {
+      propDefinition: [
+        twitter,
+        "sinceId",
+      ],
+    },
+    enrichTweets: {
+      propDefinition: [
+        twitter,
+        "enrichTweets",
+      ],
+    },
+    count: {
+      propDefinition: [
+        twitter,
+        "count",
+      ],
+    },
+    maxRequests: {
+      propDefinition: [
+        twitter,
+        "maxRequests",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      lang,
+      locale,
+      geocode,
+      resultType,
+      enrichTweets,
+      includeReplies,
+      includeRetweets,
+      sinceId,
+      maxRequests,
+      count,
+      q,
+    } = this;
+
+    // run paginated search
+    const res = await this.twitter.paginatedSearch({
+      $,
+      q,
+      sinceId,
+      lang,
+      locale,
+      geocode,
+      resultType,
+      enrichTweets,
+      includeReplies,
+      includeRetweets,
+      maxRequests,
+      count,
+      limitFirstPage: false,
+    });
+    $.export("$summary", "Search completed successfully");
+    return res;
+  },
+};

package/actions/common.mjs

@@ -0,0 +1,29 @@
+import twitter from "../twitter.app.mjs";
+
+export default {
+  props: {
+    twitter,
+  },
+  methods: {
+    async *paginate(resourceFn, params = {}, resourceType = null) {
+      const { maxRequests = 1 } = params;
+      delete params.maxResults;
+      let count = 0;
+      let cursor = true;
+      while (cursor && count < maxRequests) {
+        const results = await resourceFn(params);
+        const items = resourceType
+          ? results[resourceType]
+          : results;
+        for (const item of items) {
+          yield item;
+        }
+        cursor = results.next_cursor;
+        if (cursor) {
+          params.cursor = cursor;
+        }
+        count++;
+      }
+    },
+  },
+};

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

@@ -0,0 +1,146 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-create-tweet",
+  name: "Create Tweet",
+  description: "Create a new tweet. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update)",
+  version: "0.0.3",
+  type: "action",
+  props: {
+    twitter,
+    status: {
+      propDefinition: [
+        twitter,
+        "status",
+      ],
+    },
+    inReplyToStatusId: {
+      propDefinition: [
+        twitter,
+        "inReplyToStatusId",
+      ],
+    },
+    autoPopulateReplyMetadata: {
+      propDefinition: [
+        twitter,
+        "autoPopulateReplyMetadata",
+      ],
+    },
+    excludeReplyUserIds: {
+      propDefinition: [
+        twitter,
+        "excludeReplyUserIds",
+      ],
+    },
+    attachmentUrl: {
+      propDefinition: [
+        twitter,
+        "attachmentUrl",
+      ],
+    },
+    mediaIds: {
+      propDefinition: [
+        twitter,
+        "mediaIds",
+      ],
+    },
+    possiblySensitive: {
+      propDefinition: [
+        twitter,
+        "possiblySensitive",
+      ],
+    },
+    lat: {
+      propDefinition: [
+        twitter,
+        "lat",
+      ],
+    },
+    long: {
+      propDefinition: [
+        twitter,
+        "long",
+      ],
+    },
+    placeId: {
+      propDefinition: [
+        twitter,
+        "placeId",
+      ],
+    },
+    displayCoordinates: {
+      propDefinition: [
+        twitter,
+        "displayCoordinates",
+      ],
+    },
+    trimUser: {
+      propDefinition: [
+        twitter,
+        "trimUser",
+      ],
+    },
+    enableDmcommands: {
+      propDefinition: [
+        twitter,
+        "enableDmcommands",
+      ],
+    },
+    failDmcommands: {
+      propDefinition: [
+        twitter,
+        "failDmcommands",
+      ],
+    },
+    cardUri: {
+      propDefinition: [
+        twitter,
+        "cardUri",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      status,
+      inReplyToStatusId,
+      autoPopulateReplyMetadata,
+      excludeReplyUserIds,
+      attachmentUrl,
+      mediaIds,
+      possiblySensitive,
+      lat,
+      long,
+      placeId,
+      displayCoordinates,
+      trimUser,
+      enableDmcommands,
+      failDmcommands,
+      cardUri,
+    } = this;
+
+    const params = {
+      status,
+      inReplyToStatusId,
+      autoPopulateReplyMetadata,
+      excludeReplyUserIds,
+      attachmentUrl,
+      media_ids: mediaIds,
+      possiblySensitive,
+      lat,
+      long,
+      placeId,
+      displayCoordinates,
+      trimUser,
+      enableDmcommands,
+      failDmcommands,
+      cardUri,
+    };
+    Object.keys(params).forEach((k) => params[k] == "" && delete params[k]);
+    const res = await this.twitter.createTweet({
+      $,
+      params,
+    });
+    $.export("$summary", "Successfully posted tweet");
+    return res;
+  },
+};

package/actions/delete-tweet/delete-tweet.mjs

@@ -0,0 +1,42 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-delete-tweet",
+  name: "Delete Tweet",
+  description: "Remove a posted tweet. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-destroy-id)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    twitter,
+    tweetID: {
+      propDefinition: [
+        twitter,
+        "tweetID",
+      ],
+    },
+    trimUser: {
+      propDefinition: [
+        twitter,
+        "trimUser",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      tweetID,
+      trimUser,
+    } = this;
+
+    const params = {
+      tweetID,
+      trimUser,
+    };
+
+    const res = await this.twitter.deleteTweet({
+      $,
+      ...params,
+    });
+    $.export("$summary", "Successfully deleted tweet");
+    return res;
+  },
+};

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

@@ -0,0 +1,48 @@
+import twitter from "../../twitter.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "twitter-follow-user",
+  name: "Follow User",
+  description: "Follow a user specified by ID or screen name parameter. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    twitter,
+    userId: {
+      propDefinition: [
+        twitter,
+        "userId",
+      ],
+      optional: true,
+    },
+    screenName: {
+      propDefinition: [
+        twitter,
+        "screenName",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      userId,
+      screenName,
+    } = this;
+
+    if (!userId && !screenName) {
+      throw new ConfigurationError("This action requires either User ID or Screen Name. Please enter one or the other above.");
+    }
+
+    const params = {
+      user_id: userId,
+      screen_name: screenName,
+    };
+    const response = await this.twitter.followUser({
+      params,
+      $,
+    });
+    $.export("$summary", `Successfully followed user @${response.screen_name}`);
+    return response;
+  },
+};

package/actions/get-tweet/get-tweet.mjs

@@ -0,0 +1,42 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-get-tweet",
+  name: "Get Tweet",
+  description: "Return a single tweet specified by ID. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-show-id)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    twitter,
+    id: {
+      propDefinition: [
+        twitter,
+        "tweetID",
+      ],
+    },
+    includeEntities: {
+      propDefinition: [
+        twitter,
+        "includeEntities",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      id,
+      includeEntities,
+    } = this;
+
+    const params = {
+      id,
+      includeEntities,
+    };
+
+    const res = await this.twitter.getTweet({
+      $,
+      ...params,
+    });
+    $.export("$summary", "Successfully retrieved tweet");
+    return res;
+  },
+};

package/actions/get-user/get-user.mjs

@@ -0,0 +1,50 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-get-user",
+  name: "Get User",
+  description: "Return information about the user specified by ID or screen name parameter. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    twitter,
+    userId: {
+      propDefinition: [
+        twitter,
+        "userId",
+      ],
+      optional: true,
+    },
+    screenName: {
+      propDefinition: [
+        twitter,
+        "screenName",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      userId,
+      screenName,
+    } = this;
+
+    if (!userId && !screenName) {
+      throw new Error("This action requires either User ID or Screen Name. Please enter one or the other above.");
+    }
+
+    const userIdArray = [
+      userId,
+    ];
+    const screenNameArray = [
+      screenName,
+    ];
+    const res = await this.twitter.lookupUsers({
+      $,
+      userIdArray,
+      screenNameArray,
+    });
+    $.export("$summary", "Successfully retrieved user");
+    return res;
+  },
+};

package/actions/like-tweet/like-tweet.mjs

@@ -0,0 +1,42 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-like-tweet",
+  name: "Like Tweet",
+  description: "Like the tweet specified specified in the ID parameter. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-create)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    twitter,
+    id: {
+      propDefinition: [
+        twitter,
+        "tweetID",
+      ],
+    },
+    includeEntities: {
+      propDefinition: [
+        twitter,
+        "includeEntities",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      id,
+      includeEntities,
+    } = this;
+
+    const params = {
+      id,
+      includeEntities,
+    };
+
+    const res = await this.twitter.likeTweet({
+      $,
+      ...params,
+    });
+    $.export("$summary", "Successfully liked tweet");
+    return res;
+  },
+};

package/actions/list-favorites/list-favorites.mjs

@@ -0,0 +1,63 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "twitter-list-favorites",
+  name: "List Favorites",
+  description: "Return the most recent tweets liked by you or the specified user. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-favorites-list)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    screenName: {
+      propDefinition: [
+        common.props.twitter,
+        "screenName",
+      ],
+    },
+    count: {
+      propDefinition: [
+        common.props.twitter,
+        "count",
+      ],
+      description: "Specifies the number of records to retrieve. Must be less than or equal to `200`; defaults to `20`.",
+      optional: true,
+      default: 20,
+    },
+    maxRequests: {
+      propDefinition: [
+        common.props.twitter,
+        "maxRequests",
+      ],
+    },
+    includeEntities: {
+      propDefinition: [
+        common.props.twitter,
+        "includeEntities",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      screenName,
+      count,
+      maxRequests,
+      includeEntities,
+    } = this;
+
+    const params = {
+      $,
+      screenName,
+      count,
+      maxRequests,
+      include_entities: includeEntities,
+    };
+    const tweets = await this.paginate(this.twitter.getLikedTweets.bind(this), params);
+    const results = [];
+    for await (const tweet of tweets) {
+      results.push(tweet);
+    }
+    $.export("$summary", "Successfully retrieved favorites");
+    return results;
+  },
+};

package/actions/list-followers/list-followers.mjs

@@ -0,0 +1,67 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "twitter-list-followers",
+  name: "List Followers",
+  description: "Return a collection of user objects for users following the specified user. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-list)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    userId: {
+      propDefinition: [
+        common.props.twitter,
+        "userId",
+      ],
+      optional: true,
+    },
+    screenName: {
+      propDefinition: [
+        common.props.twitter,
+        "screenName",
+      ],
+      optional: true,
+    },
+    maxRequests: {
+      propDefinition: [
+        common.props.twitter,
+        "maxRequests",
+      ],
+    },
+    includeUserEntities: {
+      propDefinition: [
+        common.props.twitter,
+        "includeUserEntities",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      userId,
+      screenName,
+      maxRequests,
+      includeUserEntities,
+    } = this;
+
+    if (!userId && !screenName) {
+      throw new Error("This action requires either User ID or Screen Name. Please enter one or the other above.");
+    }
+
+    const params = {
+      $,
+      userId,
+      screenName,
+      maxRequests,
+      includeUserEntities,
+    };
+
+    const followers = await this.paginate(this.twitter.getFollowers.bind(this), params, "users");
+    const results = [];
+    for await (const follower of followers) {
+      results.push(follower);
+    }
+    $.export("$summary", "Successfully retrieved followers");
+    return results;
+  },
+};