@pipedream/linkedin 0.0.1

package/actions/query-analytics-finder/query-analytics-finder.mjs

@@ -0,0 +1,197 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-query-analytics-finder",
+  name: "Query Analytics Finder",
+  description: "Queries the Analytics Finder to get analytics for the specified entity i.e company, account, campaign. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting#analytics-finder)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    dateRangeStartDay: {
+      type: "string",
+      label: "Date Range Start Day",
+      description: "Represents the inclusive start time range, day component, of the analytics. If unset, it indicates an open range up to the end time. The day is represented in integer. Valid range from 1 to 31 depending on month.",
+      optional: true,
+    },
+    dateRangeStartMonth: {
+      type: "string",
+      label: "Date Range Start Month",
+      description: "Represents the inclusive start time range, month component, of the analytics. If unset, it indicates an open range up to the end time. The month is represented in integer. Valid range from 1 to 12.",
+      optional: true,
+    },
+    dateRangeStartYear: {
+      type: "string",
+      label: "Date Range Start Year",
+      description: "Represents the inclusive start time range, year component, of the analytics. If unset, it indicates an open range up to the end time. The year is represented in integer.",
+      optional: true,
+    },
+    dateRangeEndDay: {
+      type: "string",
+      label: "Date Range End Day",
+      description: "Represents the inclusive end time range, day component, of the analytics. Must be after start time if it's present. If unset, it indicates an open range from start time to everything after. The day is represented in integer. Valid range from 1 to 31 depending on month.",
+      optional: true,
+    },
+    dateRangeEndMonth: {
+      type: "string",
+      label: "Date Range End Month",
+      description: "Represents the inclusive end time range, month component, of the analytics. Must be after start time if it's present. If unset, it indicates an open range from start time to everything after. The month is represented in integer. Valid range from 1 to 12.",
+      optional: true,
+    },
+    dateRangeEndYear: {
+      type: "string",
+      label: "Date Range End Year",
+      description: "Represents the inclusive end time range, year component, of the analytics. Must be after start time if it's present. If unset, it indicates an open range from start time to everything after. The year is represented in integer.",
+      optional: true,
+    },
+    campaignType: {
+      type: "any",
+      label: "Campaign Type",
+      description: "An [Array of Campaign Type Values](https://docs.microsoft.com/en-us/linkedin/shared/references/v2/ads/adaccounts?context=linkedin/marketing/context). Required unless another facet is provided. Supported types are [TEXT_AD, SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC]. Requires at least one other facet.",
+      optional: true,
+    },
+    shares: {
+      type: "any",
+      label: "Shares",
+      description: "An [Array of Share URN](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/share-api). Required unless another facet is provided.",
+      optional: true,
+    },
+    campaigns: {
+      type: "any",
+      label: "Campaigns",
+      description: "An [Array of Sponsored Campaign URN](https://docs.microsoft.com/en-us/linkedin/shared/references/v2/ads/adcampaigns?context=linkedin/marketing/context). Required unless another facet is provided.",
+      optional: true,
+    },
+    creatives: {
+      type: "any",
+      label: "Creatives",
+      description: "An [Array of Sponsored Creative URN](https://docs.microsoft.com/en-us/linkedin/shared/references/v2/ads/adcreatives?context=linkedin/marketing/context). Required unless another facet is provided.",
+      optional: true,
+    },
+    campaignGroups: {
+      type: "any",
+      label: "Campaign Groups",
+      description: "An [Array of Campaign Group URN](https://docs.microsoft.com/en-us/linkedin/shared/references/v2/ads/adcampaigngroups?context=linkedin/marketing/context). Required unless another facet is provided.",
+      optional: true,
+    },
+    accounts: {
+      type: "any",
+      label: "Accounts",
+      description: "An [Array of Account URN](https://docs.microsoft.com/en-us/linkedin/shared/references/v2/ads/adaccounts?context=linkedin/marketing/context). Required unless another facet is provided.",
+      optional: true,
+    },
+    companies: {
+      type: "any",
+      label: "Companies",
+      description: "An [Array of Organization URN](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/organizations/organization-lookup-api). Required unless another facet is provided.",
+      optional: true,
+    },
+    pivot: {
+      propDefinition: [
+        linkedin,
+        "pivot",
+      ],
+    },
+    timeGranularity: {
+      propDefinition: [
+        linkedin,
+        "timeGranularity",
+      ],
+    },
+    projection: {
+      type: "string",
+      label: "Projection",
+      description: "Decoration statement used to fetch data belonging to URN objects within the Analytics Finder, without having to make an extra call to that object's API. \nDecoration is a mechanism in LinkedIn's APIs to fetch data belonging to a URN object without having to make an extra call to that object's API. See [Response Decoration.](https://docs.microsoft.com/en-us/linkedin/shared/api-guide/concepts/decoration)",
+      optional: true,
+    },
+    fields: {
+      type: "string",
+      label: "Fields",
+      description: "Specifies the fields. limited set of metrics to retrieve. Available fields: externalWebsiteConversions, dateRange, impressions, landingPageClicks, likes, shares, costInLocalCurrency, pivot, pivotValue.",
+      optional: true,
+    },
+  },
+  methods: {
+    //This is a helper function that will generate the query string
+    // for parameter expecting URN valued arrays.
+    generateQueryStringForParamete(querystringName, parameterValuesArray) {
+      const querystringArr = parameterValuesArray;
+      var querystringArrParameter = "";
+      let i = 0;
+      if (querystringArr && querystringArr.length > 0) {
+        querystringArr.forEach((querystringArrItem) =>  {
+          if (i == 0) {
+            querystringArrParameter = `&${querystringName}[${i}]=${querystringArrItem}&`;
+          } else {
+            querystringArrParameter += `${querystringName}[${i}]=${querystringArrItem}&`;
+          }
+          i++;
+        });
+        querystringArrParameter = querystringArrParameter.substring(
+          0,
+          querystringArrParameter.length - 1,
+        );
+      }
+      return querystringArrParameter;
+    },
+  },
+  async run({ $ }) {
+    //Populates the dateRange.end and dataRange.start parameters to the Analytics Finder request.
+    const dateRange = {
+      start: {
+        day: this.dateRangeStartDay,
+        month: this.dateRangeStartMonth,
+        year: this.dateRangeStartYear,
+      },
+      end: {
+        day: this.dateRangeEndDay,
+        month: this.dateRangeEndMonth,
+        year: this.dateRangeEndYear,
+      },
+    };
+
+    let dateRangeQueryString = "";
+    if (dateRange.start.year) {
+      dateRangeQueryString += `&dateRange.start.year=${dateRange.start.year}`;
+    }
+
+    if (dateRange.start.month) {
+      dateRangeQueryString += `&dateRange.start.month=${dateRange.start.month}`;
+    }
+
+    if (dateRange.start.day) {
+      dateRangeQueryString += `&dateRange.start.day=${dateRange.start.day}`;
+    }
+
+    if (dateRange.end.year) {
+      dateRangeQueryString += `&dateRange.end.year=${dateRange.end.year}`;
+    }
+
+    if (dateRange.end.month) {
+      dateRangeQueryString += `&dateRange.end.month=${dateRange.end.month}`;
+    }
+
+    if (dateRange.end.day) {
+      dateRangeQueryString += `&dateRange.end.day=${dateRange.end.day}`;
+    }
+
+    //Generates URN based arrays using helper function
+    const campaignTypeQsparam = this.generateQueryStringForParameter("campaignType", this.campaignType);
+    const sharesQsparam = this.generateQueryStringForParameter("shares", this.shares);
+    const campaignsQsparam = this.generateQueryStringForParameter("campaigns", this.campaigns);
+    const creativesQsparam = this.generateQueryStringForParameter("creatives", this.creatives);
+    const campaignGroupsQsparam = this.generateQueryStringForParameter("campaignGroups", this.campaignGroups);
+    const accountsQsparam = this.generateQueryStringForParameter("accounts", this.accounts);
+    const companiesQsparam = this.generateQueryStringForParameter("companies", this.companies);
+
+    const querystring = ` ${dateRangeQueryString}${campaignTypeQsparam}${sharesQsparam}${sharesQsparam}${campaignsQsparam}${creativesQsparam}${accountsQsparam}${campaignGroupsQsparam}${companiesQsparam}`;
+
+    const response = await this.linkedin.queryAnaltyics(querystring, {
+      $,
+    });
+
+    $.export("$summary", "Successfully retrieved analytics information");
+
+    return response;
+  },
+};

package/actions/retrieve-comments-on-comments/retrieve-comments-on-comments.mjs

@@ -0,0 +1,49 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-retrieve-comments-on-comments",
+  name: "Retrieves Comments on Comments",
+  description: "Retrieves comments on comments, given the parent comment urn. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/network-update-social-actions#retrieve-comments-on-comments)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    commentUrn: {
+      type: "string",
+      label: "Comment Urn",
+      description: "To resolve nested comments for a given parent comment, provide a parent `commentUrn` as the target in the request URL. A `commentUrn` is a composite URN constructed using a comment ID and `activityUrn`.",
+    },
+    max: {
+      propDefinition: [
+        linkedin,
+        "max",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const count = 50;
+    const results = [];
+
+    const params = {
+      start: 0,
+      count,
+    };
+
+    let done = false;
+    do {
+      const { elements } = await this.linkedin.getComments(encodeURIComponent(this.commentUrn), {
+        $,
+        params,
+      });
+      results.push(...elements);
+      params.start += count;
+      if (elements?.length < count) {
+        done = true;
+      }
+    } while (results.length < this.max && !done);
+
+    $.export("$summary", `Successfully retrieved ${results.length} comment(s)`);
+
+    return results;
+  },
+};

package/actions/retrieve-comments-shares/retrieve-comments-shares.mjs

@@ -0,0 +1,49 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-retrieve-comments-shares",
+  name: "Retrieve Comments On Shares",
+  description: "Retrieve comments on shares given the share urn. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/network-update-social-actions#retrieve-comments-on-shares)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    entityUrn: {
+      type: "string",
+      label: "Entity Urn",
+      description: "Urn of the entity to retreive comments on.",
+    },
+    max: {
+      propDefinition: [
+        linkedin,
+        "max",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const count = 50;
+    const results = [];
+
+    const params = {
+      start: 0,
+      count,
+    };
+
+    let done = false;
+    do {
+      const { elements } = await this.linkedin.getComments(encodeURIComponent(this.entityUrn), {
+        $,
+        params,
+      });
+      results.push(...elements);
+      params.start += count;
+      if (elements?.length < count) {
+        done = true;
+      }
+    } while (results.length < this.max && !done);
+
+    $.export("$summary", `Successfully retrieved ${results.length} comment(s)`);
+
+    return results;
+  },
+};

package/actions/search-organization/search-organization.mjs

@@ -0,0 +1,59 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-search-organization",
+  name: "Search Organization",
+  description: "Searches for an organization by vanity name or email domain. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/organizations/organization-lookup-api)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    searchBy: {
+      type: "string",
+      label: "Search By",
+      description: "You can look up the `id`, `name`, `localizedName`, `vanityName`, `localizedWebsite`, `logoV2`, and `location` of any organization using `vanityName` or `emailDomain`",
+      options: [
+        "vanityName",
+        "emailDomain",
+      ],
+    },
+    searchTerm: {
+      type: "string",
+      label: "Search Term",
+      description: "Keyword to search for",
+    },
+    max: {
+      propDefinition: [
+        linkedin,
+        "max",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const count = 50;
+    const results = [];
+
+    const params = {
+      start: 0,
+      count,
+    };
+    const querystring = `${this.searchBy}&${this.searchBy}=${this.searchTerm}`;
+
+    let done = false;
+    do {
+      const { elements } = await this.linkedin.searchOrganizations(querystring, {
+        $,
+        params,
+      });
+      results.push(...elements);
+      params.start += count;
+      if (elements?.length < count) {
+        done = true;
+      }
+    } while (results.length < this.max && !done);
+
+    $.export("$summary", "Successfully searched organizations");
+
+    return results;
+  },
+};

package/actions/share-content/share-content.mjs

@@ -0,0 +1,59 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-share-content",
+  name: "Share Content",
+  description: "Shares a post with content, which represents external articles and media such as images referenced in a share. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/share-api#post-shares)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    organizationId: {
+      propDefinition: [
+        linkedin,
+        "organizationId",
+      ],
+      optional: true,
+    },
+    shareContent: {
+      type: "object",
+      label: "Share Content",
+      description: "Referenced content such as articles and images. See the Schema of this property in [Share Content](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/share-api#share-content).",
+    },
+    distribution: {
+      type: "object",
+      label: "Distribution",
+      description: "Distribution target for the share. Required to set the share as publicly visible. For sponsored content where the targeting is defined when it is sponsored, distribution should be null. See the Schema of this property in [Share Distribution Target](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/share-api#share-distribution-targets)",
+      optional: true,
+    },
+    text: {
+      type: "string",
+      label: "Share Text",
+      description: "Text of the share.",
+    },
+    visibility: {
+      propDefinition: [
+        linkedin,
+        "visibility",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const data = {
+      author: this.organizationId,
+      content: this.shareContent,
+      distribution: this.distribution,
+      commentary: this.text,
+      visibility: this.visibility,
+    };
+
+    const response = await this.linkedin.createPost({
+      $,
+      data,
+    });
+
+    $.export("$summary", "Successfully shared content");
+
+    return response;
+  },
+};

package/actions/share-text-mentions/share-text-mentions.mjs

@@ -0,0 +1,52 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-share-text-mentions",
+  name: "Share Text And Mentions",
+  description: "Shares a posts with text and mentions only. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/share-api#share-text-and-mentions)",
+  version: "0.3.2",
+  type: "action",
+  props: {
+    linkedin,
+    organizationId: {
+      propDefinition: [
+        linkedin,
+        "organizationId",
+      ],
+      optional: true,
+    },
+    shareText: {
+      type: "string",
+      label: "Share Text",
+      description: "Text of the share.",
+    },
+    annotations: {
+      type: "any",
+      label: "Annotations",
+      description: "Annotations of the shared text, which are mentions or tags of other Linkedin entities such as organizations or members, see the full schema in [Share Text and Mentions](https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/posts-api?view=li-lms-2022-11&tabs=http#mentions-and-hashtags-using-posts-commentary)",
+      optional: true,
+    },
+    visibility: {
+      propDefinition: [
+        linkedin,
+        "visibility",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const data = {
+      author: this.organizationId,
+      commentary: `${this.shareText}${this.annotations}`,
+      visibility: this.visibility,
+    };
+
+    const response = await this.linkedin.createPost({
+      $,
+      data,
+    });
+
+    $.export("$summary", "Successfully shared post");
+
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,88 @@
+const VERSION_PATH = "rest";
+const BASE_URL = "https://api.linkedin.com/";
+const VERSION_HEADER = "202206";
+
+const VISIBILITIES = [
+  {
+    label: "Connections",
+    value: "CONNECTIONS",
+  },
+  {
+    label: "Public",
+    value: "PUBLIC",
+  },
+  {
+    label: "Logged in",
+    value: "LOGGED_IN",
+  },
+];
+
+const TYPES = [
+  {
+    label: "Text/URL",
+    value: "NONE",
+  },
+  {
+    label: "Article",
+    value: "ARTICLE",
+  },
+];
+
+const TIME_GRANULARITY_OPTIONS = [
+  "ALL",
+  "DAILY",
+  "MONTHLY",
+  "YEARLY",
+];
+
+const PIVOT_OPTIONS = [
+  "COMPANY",
+  "ACCOUNT",
+  "SHARE",
+  "CAMPAIGN",
+  "CREATIVE",
+  "CAMPAIGN_GROUP",
+  "CONVERSION",
+  "CONVERSATION_NODE",
+  "CONVERSATION_NODE_OPTION_INDEX",
+  "SERVING_LOCATION",
+  "CARD_INDEX",
+  "MEMBER_COMPANY_SIZE",
+  "MEMBER_INDUSTRY",
+  "MEMBER_SENIORITY",
+  "MEMBER_JOB_TITLE",
+  "MEMBER_JOB_FUNCTION",
+  "MEMBER_COUNTRY_V2",
+  "MEMBER_REGION_V2",
+  "MEMBER_COMPANY",
+];
+
+const ORGANIZATION_ROLES = [
+  "ADMINISTRATOR",
+  "DIRECT_SPONSORED_CONTENT_POSTER",
+  "RECRUITING_POSTER",
+  "LEAD_CAPTURE_ADMINISTRATOR",
+  "LEAD_GEN_FORMS_MANAGER",
+  "ANALYST",
+  "CURATOR",
+  "CONTENT_ADMINISTRATOR",
+];
+
+const ROLE_STATES = [
+  "APPROVED",
+  "REJECTED",
+  "REQUESTED",
+  "REVOKED",
+];
+
+export default {
+  VERSION_PATH,
+  BASE_URL,
+  VERSION_HEADER,
+  VISIBILITIES,
+  TYPES,
+  TIME_GRANULARITY_OPTIONS,
+  PIVOT_OPTIONS,
+  ORGANIZATION_ROLES,
+  ROLE_STATES,
+};