@pipedream/linkedin 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Pipedream, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/actions/analytics-finder-account-sample/analytics-finder-account-sample.mjs

@@ -0,0 +1,44 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-analytics-finder-account-sample",
+  name: "Query Analytics Finder Account Sample",
+  description: "Sample query using analytics finder that gets analytics for a particular account for date range starting in a given year. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting#sample-request)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    startYear: {
+      propDefinition: [
+        linkedin,
+        "startYear",
+      ],
+    },
+    timeGranularity: {
+      propDefinition: [
+        linkedin,
+        "timeGranularity",
+      ],
+    },
+    adAccountId: {
+      propDefinition: [
+        linkedin,
+        "adAccountId",
+      ],
+    },
+  },
+  async run({ $ }) {
+  // Note: This action is based on the LinkedIn Analytics Finder sample request.
+  // It was modified to use an sponsored account to match results by.
+
+    const querystring = `&pivot=ACCOUNT&dateRange.start.day=1&dateRange.start.month=1&dateRange.start.year=${this.startYear}&timeGranularity=${this.timeGranularity}&accounts[0]=urn:li:sponsoredAccount:${this.adAccountId}`;
+
+    const response = await this.linkedin.queryAnalytics(querystring, {
+      $,
+    });
+
+    $.export("$summary", "Successfully retrieved analytics");
+
+    return response;
+  },
+};

package/actions/analytics-finder-campaign-sample/analytics-finder-campaign-sample.mjs

@@ -0,0 +1,44 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-analytics-finder-campaign-sample",
+  name: "Query Analytics Finder Campaign Sample",
+  description: "Sample query using analytics finder that gets analytics for a particular campaign in a date range starting in a given year. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting#analytics-finder)",
+  version: "0.2.2",
+  type: "action",
+  props: {
+    linkedin,
+    startYear: {
+      propDefinition: [
+        linkedin,
+        "startYear",
+      ],
+    },
+    timeGranularity: {
+      propDefinition: [
+        linkedin,
+        "timeGranularity",
+      ],
+    },
+    campaignId: {
+      propDefinition: [
+        linkedin,
+        "campaignId",
+      ],
+    },
+  },
+  async run({ $ }) {
+  // Note: This action is based on the LinkedIn Analytics Finder sample request.
+  // As such, it uses an sponsored campaign to match results by.
+
+    const querystring = `&pivot=CAMPAIGN&dateRange.start.day=1&dateRange.start.month=1&dateRange.start.year=${this.startYear}&timeGranularity=${this.timeGranularity}&campaigns[0]=urn:li:sponsoredCampaign:${this.campaignId}`;
+
+    const response = await this.linkedin.queryAnalytics(querystring, {
+      $,
+    });
+
+    $.export("$summary", "Successfully retrieved analytics");
+
+    return response;
+  },
+};

package/actions/create-comment/create-comment.mjs

@@ -0,0 +1,58 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-create-comment",
+  name: "Create Comment",
+  description: "Create a comment on a share or user generated content post. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/network-update-social-actions#create-comment)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    urnToComment: {
+      type: "string",
+      label: "Urn to comment",
+      description: "The share or user generated content post where the comment will be made.",
+    },
+    actor: {
+      type: "string",
+      label: "Actor",
+      description: "Entity which is authoring the comment, must be a person or an organization URN.",
+    },
+    message: {
+      type: "string",
+      label: "Message",
+      description: "Text of the comment. May contain attributes such as links to people and organizations.",
+    },
+    content: {
+      type: "any",
+      label: "Content",
+      description: "Array of a media content entities.",
+      optional: true,
+    },
+    parentComment: {
+      type: "string",
+      label: "Parent Comment",
+      description: "For nested comments, this is the urn of the parent comment. This is not available for first-level comments.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const data = {
+      object: this.urnToComment,
+      actor: this.actor,
+      message: {
+        text: this.message,
+      },
+      content: this.content,
+      parentComment: this.parentComment,
+    };
+    const response = await this.linkedin.createComment(encodeURIComponent(this.urnToComment), {
+      $,
+      data,
+    });
+
+    $.export("$summary", "Successfully created comment");
+
+    return response;
+  },
+};

package/actions/create-like-on-share/create-like-on-share.mjs

@@ -0,0 +1,42 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-create-like-on-share",
+  name: "Create Like On Share",
+  description: "Creates a like on a share. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/network-update-social-actions#create-a-like-on-a-share)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    parentUrn: {
+      type: "string",
+      label: "Parent Urn",
+      description: "The top-level share urn or user generated content where the like will be performed.",
+    },
+    actor: {
+      type: "string",
+      label: "Actor",
+      description: "Entity performing the like. Must be a person or an organization URN.",
+    },
+    object: {
+      type: "string",
+      label: "Object",
+      description: "Use the `object` field in the request body to specify the URN of the entity to which the like belongs. This object should be a sub-entity of the top-level share indicated in the request URL",
+    },
+  },
+  async run({ $ }) {
+    const data = {
+      actor: this.actor,
+      object: this.object,
+    };
+
+    const response = await this.linkedin.createLikeOnShare(encodeURIComponent(this.parentUrn), {
+      $,
+      data,
+    });
+
+    $.export("$summary", "Successfully created like on share");
+
+    return response;
+  },
+};

package/actions/create-text-post-organization/create-text-post-organization.mjs

@@ -0,0 +1,37 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-create-text-post-organization",
+  name: "Create a Simple Post (Organization)",
+  description: "Create post on LinkedIn using text, URL or article. [See the docs](https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/posts-api?view=li-lms-2022-11&tabs=http#create-organic-posts) for more information",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    linkedin,
+    organizationId: {
+      propDefinition: [
+        linkedin,
+        "organizationId",
+      ],
+    },
+    text: {
+      propDefinition: [
+        linkedin,
+        "text",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const data = {
+      author: this.organizationId,
+      commentary: this.text,
+      visibility: "PUBLIC",
+    };
+    const response = await this.linkedin.createPost({
+      $,
+      data,
+    });
+    $.export("$summary", "Successfully created a new Post as Organization");
+    return response;
+  },
+};

package/actions/create-text-post-user/create-text-post-user.mjs

@@ -0,0 +1,36 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-create-text-post-user",
+  name: "Create a Simple Post (User)",
+  description: "Create post on LinkedIn using text, URL or article. [See the docs](https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/posts-api?view=li-lms-2022-11&tabs=http#create-organic-posts) for more information",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    linkedin,
+    visibility: {
+      propDefinition: [
+        linkedin,
+        "visibility",
+      ],
+    },
+    text: {
+      propDefinition: [
+        linkedin,
+        "text",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const data = {
+      commentary: this.text,
+      visibility: this.visibility,
+    };
+    const response = await this.linkedin.createPost({
+      $,
+      data,
+    });
+    $.export("$summary", "Successfully created a new Post as User");
+    return response;
+  },
+};

package/actions/delete-post/delete-post.mjs

@@ -0,0 +1,25 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-delete-post",
+  name: "Delete Post",
+  description: "Removes a post from user's wall. [See the docs](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/share-api?tabs=http#delete-shares) for more information",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    linkedin,
+    postId: {
+      propDefinition: [
+        linkedin,
+        "postId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.linkedin.deletePost(encodeURIComponent(this.postId), {
+      $,
+    });
+    $.export("$summary", "Successfully deleted post");
+    return response;
+  },
+};

package/actions/fetch-ad-account/fetch-ad-account.mjs

@@ -0,0 +1,28 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-fetch-ad-account",
+  name: "Fetch Ad Account",
+  description: "Fetches an individual adAccount given its id. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts#fetch-ad-account)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    adAccountId: {
+      propDefinition: [
+        linkedin,
+        "adAccountId",
+      ],
+      description: "ID of the adAccount to fetch.",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.linkedin.getAdAccount(encodeURIComponent(this.adAccountId), {
+      $,
+    });
+
+    $.export("$summary", "Successfully retrieved Ad Account");
+
+    return response;
+  },
+};

package/actions/get-current-member-profile/get-current-member-profile.mjs

@@ -0,0 +1,21 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-get-current-member-profile",
+  name: "Get Current Member Profile",
+  description: "Gets the profile of the current authenticated member. [See the docs here](https://docs.microsoft.com/en-us/linkedin/shared/integrations/people/profile-api#retrieve-current-members-profile)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+  },
+  async run({ $ }) {
+    const response = await this.linkedin.getCurrentMemberProfile({
+      $,
+    });
+
+    $.export("$summary", "Successfully retrieved current member profile");
+
+    return response;
+  },
+};

package/actions/get-member-organization-access-control/get-member-organization-access-control.mjs

@@ -0,0 +1,59 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-get-member-organization-access-control",
+  name: "Get Member's Organization Access Control Information",
+  description: "Gets the organization access control information of the current authenticated member. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/organizations/organization-access-control?context=linkedin/compliance/context#find-a-members-organization-access-control-information)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    role: {
+      propDefinition: [
+        linkedin,
+        "role",
+      ],
+    },
+    state: {
+      propDefinition: [
+        linkedin,
+        "state",
+      ],
+    },
+    max: {
+      propDefinition: [
+        linkedin,
+        "max",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const count = 50;
+    const results = [];
+
+    const params = {
+      q: "roleAssignee",
+      role: this.role,
+      state: this.state,
+      start: 0,
+      count,
+    };
+
+    let done = false;
+    do {
+      const { elements } = await this.linkedin.getAccessControl({
+        $,
+        params,
+      });
+      results.push(...elements);
+      params.start += count;
+      if (elements?.length < count) {
+        done = true;
+      }
+    } while (results.length < this.max && !done);
+
+    $.export("$summary", "Successfully retrieved access control information");
+
+    return results;
+  },
+};

package/actions/get-member-profile/get-member-profile.mjs

@@ -0,0 +1,26 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-get-member-profile",
+  name: "Get Member Profile",
+  description: "Gets another member's profile, given its person id. [See the docs here](https://docs.microsoft.com/en-us/linkedin/shared/integrations/people/profile-api#retrieve-other-members-profile)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    personId: {
+      type: "string",
+      label: "Person Id",
+      description: "Identifier of the person to retrieve",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.linkedin.getMemberProfile(this.personId, {
+      $,
+    });
+
+    $.export("$summary", "Successfully retrieved member profile");
+
+    return response;
+  },
+};

package/actions/get-multiple-member-profiles/get-multiple-member-profiles.mjs

@@ -0,0 +1,43 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-get-multiple-member-profiles",
+  name: "Get Multiple Member Profiles",
+  description: "Gets multiple member profiles at once. [See the docs here](https://docs.microsoft.com/en-us/linkedin/shared/integrations/people/profile-api#retrieve-other-members-profile)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    peopleIds: {
+      type: "string[]",
+      label: "People Ids",
+      description: "Identifiers of the members to retrieve",
+    },
+  },
+  async run({ $ }) {
+    const peopleIdsArr = this.peopleIds;
+
+    // Generates the ids of the request with this required string format:
+    // List((id:{Person ID1}),(id:{Person ID2}),(id:{Person ID3}))
+    let peopleIdsList = "List(";
+    peopleIdsArr.forEach((personId) =>  {
+      peopleIdsList = peopleIdsList.length > 5
+        ? peopleIdsList + `,(id:${personId})`
+        : peopleIdsList + `(id:${personId})`;
+    });
+    peopleIdsList = `${peopleIdsList})`;
+
+    const params = {
+      ids: peopleIdsList,
+    };
+
+    const response = await this.linkedin.getMultipleMemberProfiles({
+      $,
+      params,
+    });
+
+    $.export("$summary", `Successfully retrieved ${this.peopleIds.length} member profile(s)`);
+
+    return response;
+  },
+};

package/actions/get-organization-access-control/get-organization-access-control.mjs

@@ -0,0 +1,51 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-get-organization-access-control",
+  name: "Gets Organization Access Control",
+  description: "Gets an organization's access control information, given the organization urn. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/organizations/organization-access-control?context=linkedin/compliance/context#find-access-control-information)",
+  version: "0.1.2",
+  type: "action",
+  props: {
+    linkedin,
+    organizationUrn: {
+      type: "string",
+      label: "Organization Urn",
+      description: "The organizational entity for which the access control information is being retrieved. Must be in URN format urn:li:organization:{id}.",
+    },
+    max: {
+      propDefinition: [
+        linkedin,
+        "max",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const count = 50;
+    const results = [];
+
+    const params = {
+      q: "organization",
+      organization: encodeURI(this.organizationUrn),
+      start: 0,
+      count,
+    };
+
+    let done = false;
+    do {
+      const { elements } = await this.linkedin.getAccessControl({
+        $,
+        params,
+      });
+      results.push(...elements);
+      params.start += count;
+      if (elements?.length < count) {
+        done = true;
+      }
+    } while (results.length < this.max && !done);
+
+    $.export("$summary", "Successfully retrieved access control information");
+
+    return results;
+  },
+};

package/actions/get-organization-administrators/get-organization-administrators.mjs

@@ -0,0 +1,53 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-get-organization-administrators",
+  name: "Get Organization Administrators",
+  description: "Gets the administator members of an organization, given the organization urn. [See the docs here](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/organizations/organization-access-control?context=linkedin/compliance/context#find-organization-administrators)",
+  version: "0.2.2",
+  type: "action",
+  props: {
+    linkedin,
+    organizationUrn: {
+      type: "string",
+      label: "Organization",
+      description: "The organizational entity for which administrators are being retrieved. Must be in URN format urn:li:organization:{id}.",
+    },
+    max: {
+      propDefinition: [
+        linkedin,
+        "max",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const count = 50;
+    const results = [];
+
+    const params = {
+      q: "organization",
+      organization: encodeURI(this.organizationUrn),
+      role: "ADMINISTRATOR",
+      state: "APPROVED",
+      start: 0,
+      count,
+    };
+
+    let done = false;
+    do {
+      const { elements } = await this.linkedin.getAccessControl({
+        $,
+        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} organization administrator(s)`);
+
+    return results;
+  },
+};

package/actions/post-share/post-share.mjs

@@ -0,0 +1,53 @@
+import linkedin from "../../linkedin.app.mjs";
+
+export default {
+  key: "linkedin-post-share",
+  name: "Post Share",
+  description: "Posts a share, text, media, or rather sponsored content, in the context of a specific member or organization. [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,
+    },
+    text: {
+      type: "string",
+      label: "Share Text",
+      description: "Text of the share.",
+    },
+    visibility: {
+      propDefinition: [
+        linkedin,
+        "visibility",
+      ],
+    },
+    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).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const data = {
+      author: this.organizationId,
+      commentary: this.text,
+      visibility: this.visibility,
+      content: this.shareContent,
+    };
+
+    const response = await this.linkedin.createPost({
+      $,
+      data,
+    });
+
+    $.export("$summary", "Successfully posted message");
+
+    return response;
+  },
+};