@pipedream/recruitee 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Recruitee API allows you to automate and integrate your recruitment process with other tools and services. It provides programmatic access to manipulate jobs, candidates, and various recruitment activities. By using Pipedream, you can create custom workflows that interact with the Recruitee platform, enabling you to streamline your hiring process, synchronize recruitment data with other systems, and trigger actions based on recruitment events.
+
+# Example Use Cases
+
+- **Sync New Candidates to Google Sheets**: When a new candidate applies, automatically add their details to a Google Sheet. This workflow uses the Recruitee API to detect new candidates and the Google Sheets API to update a spreadsheet, keeping a real-time record of applicants.
+
+- **Trigger Email Campaigns for New Positions**: Send targeted email campaigns to potential candidates when a new job is posted. This workflow could use the Recruitee API to monitor for new jobs and trigger an email campaign via Mailchimp or another email service, ensuring prompt outreach to your talent pool.
+
+- **Automate Candidate Evaluation Notifications**: Notify team members in Slack when a candidate reaches a specific stage in the evaluation process. This workflow would use the Recruitee API to watch for candidate status changes and the Slack API to send messages to the relevant hiring team's channel or direct messages to specific evaluators.

package/actions/common/timezones.mjs

@@ -0,0 +1,542 @@
+export default [
+  {
+    "label": "Adelaide",
+    "value": "Australia/Adelaide",
+  },
+  {
+    "label": "Aden",
+    "value": "Asia/Aden",
+  },
+  {
+    "label": "Alaska",
+    "value": "America/Anchorage",
+  },
+  {
+    "label": "Algiers",
+    "value": "Africa/Algiers",
+  },
+  {
+    "label": "Almaty",
+    "value": "Asia/Almaty",
+  },
+  {
+    "label": "Amman",
+    "value": "Asia/Amman",
+  },
+  {
+    "label": "Amsterdam",
+    "value": "Europe/Amsterdam",
+  },
+  {
+    "label": "Amsterdam, Berlin, Rome, Stockholm, Vienna",
+    "value": "Europe/Berlin",
+  },
+  {
+    "label": "Arizona",
+    "value": "America/Phoenix",
+  },
+  {
+    "label": "Astana, Dhaka",
+    "value": "Asia/Dhaka",
+  },
+  {
+    "label": "Athens",
+    "value": "Europe/Athens",
+  },
+  {
+    "label": "Atlantic Time (Canada)",
+    "value": "Canada/Atlantic",
+  },
+  {
+    "label": "Auckland, Wellington",
+    "value": "Pacific/Auckland",
+  },
+  {
+    "label": "Azores",
+    "value": "Atlantic/Azores",
+  },
+  {
+    "label": "Baghdad",
+    "value": "Asia/Baghdad",
+  },
+  {
+    "label": "Bahrain",
+    "value": "Asia/Bahrain",
+  },
+  {
+    "label": "Baku, Tbilisi, Yerevan",
+    "value": "Asia/Baku",
+  },
+  {
+    "label": "Bangkok",
+    "value": "Asia/Bangkok",
+  },
+  {
+    "label": "Beijing, Shanghai",
+    "value": "Asia/Shanghai",
+  },
+  {
+    "label": "Beirut",
+    "value": "Asia/Beirut",
+  },
+  {
+    "label": "Belgrade, Bratislava, Ljubljana",
+    "value": "Europe/Belgrade",
+  },
+  {
+    "label": "Bogota",
+    "value": "America/Bogota",
+  },
+  {
+    "label": "Brasilia",
+    "value": "America/Araguaina",
+  },
+  {
+    "label": "Brisbane",
+    "value": "Australia/Brisbane",
+  },
+  {
+    "label": "Brussels",
+    "value": "Europe/Brussels",
+  },
+  {
+    "label": "Bucharest",
+    "value": "Europe/Bucharest",
+  },
+  {
+    "label": "Budapest",
+    "value": "Europe/Budapest",
+  },
+  {
+    "label": "Buenos Aires, Georgetown",
+    "value": "America/Argentina/Buenos_Aires",
+  },
+  {
+    "label": "Cairo",
+    "value": "Africa/Cairo",
+  },
+  {
+    "label": "Canberra, Melbourne, Sydney",
+    "value": "Australia/Sydney",
+  },
+  {
+    "label": "Cape Verde Islands",
+    "value": "Atlantic/Cape_Verde",
+  },
+  {
+    "label": "Caracas",
+    "value": "America/Caracas",
+  },
+  {
+    "label": "Casablanca",
+    "value": "Africa/Casablanca",
+  },
+  {
+    "label": "Central Time (US and Canada)",
+    "value": "America/Chicago",
+  },
+  {
+    "label": "Copenhagen",
+    "value": "Europe/Copenhagen",
+  },
+  {
+    "label": "Costa Rica",
+    "value": "America/Costa_Rica",
+  },
+  {
+    "label": "Dacca",
+    "value": "Asia/Dacca",
+  },
+  {
+    "label": "Damascus",
+    "value": "Asia/Damascus",
+  },
+  {
+    "label": "Darwin",
+    "value": "Australia/Darwin",
+  },
+  {
+    "label": "Djibouti",
+    "value": "Africa/Djibouti",
+  },
+  {
+    "label": "Dubai",
+    "value": "Asia/Dubai",
+  },
+  {
+    "label": "Dublin",
+    "value": "Europe/Dublin",
+  },
+  {
+    "label": "Eastern Time (US and Canada)",
+    "value": "America/New_York",
+  },
+  {
+    "label": "Edmonton",
+    "value": "America/Edmonton",
+  },
+  {
+    "label": "El Salvador",
+    "value": "America/El_Salvador",
+  },
+  {
+    "label": "Fiji Islands, Marshall Islands",
+    "value": "Pacific/Fiji",
+  },
+  {
+    "label": "Greenland",
+    "value": "America/Godthab",
+  },
+  {
+    "label": "Greenwich Mean Time",
+    "value": "Etc/Greenwich",
+  },
+  {
+    "label": "Guam, Port Moresby",
+    "value": "Pacific/Port_Moresby",
+  },
+  {
+    "label": "Guatemala",
+    "value": "America/Guatemala",
+  },
+  {
+    "label": "Halifax",
+    "value": "America/Halifax",
+  },
+  {
+    "label": "Harare, Pretoria",
+    "value": "Africa/Harare",
+  },
+  {
+    "label": "Hawaii",
+    "value": "Pacific/Honolulu",
+  },
+  {
+    "label": "Helsinki",
+    "value": "Europe/Helsinki",
+  },
+  {
+    "label": "Hobart",
+    "value": "Australia/Hobart",
+  },
+  {
+    "label": "Hong Kong",
+    "value": "Asia/Hong_Kong",
+  },
+  {
+    "label": "Independent State of Samoa",
+    "value": "Pacific/Apia",
+  },
+  {
+    "label": "India",
+    "value": "Asia/Calcutta",
+  },
+  {
+    "label": "Indiana (East)",
+    "value": "America/Indianapolis",
+  },
+  {
+    "label": "Irkutsk, Ulaanbaatar",
+    "value": "Asia/Irkutsk",
+  },
+  {
+    "label": "Islamabad, Karachi, Tashkent",
+    "value": "Asia/Tashkent",
+  },
+  {
+    "label": "Istanbul",
+    "value": "Europe/Istanbul",
+  },
+  {
+    "label": "Jakarta",
+    "value": "Asia/Jakarta",
+  },
+  {
+    "label": "Jerusalem",
+    "value": "Asia/Jerusalem",
+  },
+  {
+    "label": "Johannesburg",
+    "value": "Africa/Johannesburg",
+  },
+  {
+    "label": "Kabul",
+    "value": "Asia/Kabul",
+  },
+  {
+    "label": "Kamchatka",
+    "value": "Asia/Kamchatka",
+  },
+  {
+    "label": "Kathmandu",
+    "value": "Asia/Kathmandu",
+  },
+  {
+    "label": "Khartoum",
+    "value": "Africa/Khartoum",
+  },
+  {
+    "label": "Kiev",
+    "value": "Europe/Kiev",
+  },
+  {
+    "label": "Krasnoyarsk",
+    "value": "Asia/Krasnoyarsk",
+  },
+  {
+    "label": "Kuala Lumpur",
+    "value": "Asia/Kuala_Lumpur",
+  },
+  {
+    "label": "Kuwait",
+    "value": "Asia/Kuwait",
+  },
+  {
+    "label": "Lima",
+    "value": "America/Lima",
+  },
+  {
+    "label": "Lisbon",
+    "value": "Europe/Lisbon",
+  },
+  {
+    "label": "London",
+    "value": "Europe/London",
+  },
+  {
+    "label": "Luxembourg",
+    "value": "Europe/Luxembourg",
+  },
+  {
+    "label": "Madrid",
+    "value": "Europe/Madrid",
+  },
+  {
+    "label": "Magadan",
+    "value": "Asia/Magadan",
+  },
+  {
+    "label": "Managua",
+    "value": "America/Managua",
+  },
+  {
+    "label": "Mazatlan",
+    "value": "America/Mazatlan",
+  },
+  {
+    "label": "Mexico City",
+    "value": "America/Mexico_City",
+  },
+  {
+    "label": "Midway Island, Samoa",
+    "value": "Pacific/Midway",
+  },
+  {
+    "label": "Mogadishu",
+    "value": "Africa/Mogadishu",
+  },
+  {
+    "label": "Montevideo",
+    "value": "America/Montevideo",
+  },
+  {
+    "label": "Montreal",
+    "value": "America/Montreal",
+  },
+  {
+    "label": "Moscow",
+    "value": "Europe/Moscow",
+  },
+  {
+    "label": "Mountain Time (US and Canada)",
+    "value": "America/Denver",
+  },
+  {
+    "label": "Mumbai, Kolkata, New Delhi",
+    "value": "Asia/Kolkata",
+  },
+  {
+    "label": "Muscat",
+    "value": "Asia/Muscat",
+  },
+  {
+    "label": "Nairobi",
+    "value": "Africa/Nairobi",
+  },
+  {
+    "label": "New Caledonia",
+    "value": "Pacific/Noumea",
+  },
+  {
+    "label": "Newfoundland and Labrador",
+    "value": "America/St_Johns",
+  },
+  {
+    "label": "Nicosia",
+    "value": "Asia/Nicosia",
+  },
+  {
+    "label": "Nouakchott",
+    "value": "Africa/Nouakchott",
+  },
+  {
+    "label": "Novosibirsk",
+    "value": "Asia/Novosibirsk",
+  },
+  {
+    "label": "Osaka, Sapporo, Tokyo",
+    "value": "Asia/Tokyo",
+  },
+  {
+    "label": "Oslo",
+    "value": "Europe/Oslo",
+  },
+  {
+    "label": "Pacific Time (US and Canada)",
+    "value": "America/Los_Angeles",
+  },
+  {
+    "label": "Pago Pago",
+    "value": "Pacific/Pago_Pago",
+  },
+  {
+    "label": "Panama",
+    "value": "America/Panama",
+  },
+  {
+    "label": "Paris",
+    "value": "Europe/Paris",
+  },
+  {
+    "label": "Perth",
+    "value": "Australia/Perth",
+  },
+  {
+    "label": "Prague Bratislava",
+    "value": "Europe/Prague",
+  },
+  {
+    "label": "Puerto Rico",
+    "value": "America/Puerto_Rico",
+  },
+  {
+    "label": "Qatar",
+    "value": "Asia/Qatar",
+  },
+  {
+    "label": "Reykjavik",
+    "value": "Atlantic/Reykjavik",
+  },
+  {
+    "label": "Riyadh",
+    "value": "Asia/Riyadh",
+  },
+  {
+    "label": "Rome",
+    "value": "Europe/Rome",
+  },
+  {
+    "label": "Santiago",
+    "value": "America/Santiago",
+  },
+  {
+    "label": "Sao Paulo",
+    "value": "America/Sao_Paulo",
+  },
+  {
+    "label": "Sarajevo, Skopje, Zagreb",
+    "value": "CET",
+  },
+  {
+    "label": "Saskatchewan",
+    "value": "America/Regina",
+  },
+  {
+    "label": "Seoul",
+    "value": "Asia/Seoul",
+  },
+  {
+    "label": "Singapore",
+    "value": "Asia/Singapore",
+  },
+  {
+    "label": "Sofia",
+    "value": "Europe/Sofia",
+  },
+  {
+    "label": "Solomon Islands",
+    "value": "SST",
+  },
+  {
+    "label": "Stockholm",
+    "value": "Europe/Stockholm",
+  },
+  {
+    "label": "Taipei",
+    "value": "Asia/Taipei",
+  },
+  {
+    "label": "Tegucigalpa",
+    "value": "America/Tegucigalpa",
+  },
+  {
+    "label": "Tehran",
+    "value": "Asia/Tehran",
+  },
+  {
+    "label": "Tijuana",
+    "value": "America/Tijuana",
+  },
+  {
+    "label": "Tripoli",
+    "value": "Africa/Tripoli",
+  },
+  {
+    "label": "Tunis",
+    "value": "Africa/Tunis",
+  },
+  {
+    "label": "Universal Time UTC",
+    "value": "UTC",
+  },
+  {
+    "label": "Vancouver",
+    "value": "America/Vancouver",
+  },
+  {
+    "label": "Vienna",
+    "value": "Europe/Vienna",
+  },
+  {
+    "label": "Vietnam",
+    "value": "Asia/Saigon",
+  },
+  {
+    "label": "Vladivostok",
+    "value": "Asia/Vladivostok",
+  },
+  {
+    "label": "Warsaw",
+    "value": "Europe/Warsaw",
+  },
+  {
+    "label": "West Central Africa",
+    "value": "Africa/Bangui",
+  },
+  {
+    "label": "Winnipeg",
+    "value": "America/Winnipeg",
+  },
+  {
+    "label": "Yakutsk",
+    "value": "Asia/Yakutsk",
+  },
+  {
+    "label": "Yekaterinburg",
+    "value": "Asia/Yekaterinburg",
+  },
+  {
+    "label": "Zurich",
+    "value": "Europe/Zurich",
+  },
+];

package/actions/create-candidate/create-candidate.mjs

@@ -0,0 +1,63 @@
+import app from "../../recruitee.app.mjs";
+
+export default {
+  name: "Create Candidate",
+  description: "Create a new candidate. [See the documentation](https://api.recruitee.com/docs/index.html#candidate.web.candidate-candidate.web.candidate)",
+  key: "recruitee-create-candidate",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    app,
+    name: {
+      type: "string",
+      label: "Full Name",
+      description: "The full name of the candidate",
+    },
+    phones: {
+      label: "Phones",
+      description: "The candidate's phone number. e.g. `+12223334444`",
+      type: "string[]",
+      optional: true,
+    },
+    emails: {
+      label: "Emails",
+      description: "The candidate's email",
+      type: "string[]",
+      optional: true,
+    },
+    socialLinks: {
+      label: "Social Media Profiles",
+      description: "The candidate's social media profiles",
+      type: "string[]",
+      optional: true,
+    },
+    links: {
+      label: "Links",
+      description: "The candidate's external links",
+      type: "string[]",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const payload = {
+      name: this.name,
+      phones: this.phones,
+      emails: this.emails,
+      social_links: this.socialLinks,
+      links: this.links,
+    };
+    const response = await this.app.createCandidate({
+      $,
+      data: {
+        candidate: payload,
+      },
+    });
+    $.export("$summary", `Successfully created candidate with ID \`${response.candidate.id}\``);
+    return response;
+  },
+};

package/actions/create-note/create-note.mjs

@@ -0,0 +1,56 @@
+import app from "../../recruitee.app.mjs";
+
+export default {
+  name: "Create Note",
+  description: "Create a new note for a candidate. [See the documentation](https://api.recruitee.com/docs/index.html#note.web.note-note.web.note)",
+  key: "recruitee-create-note",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    app,
+    candidateId: {
+      propDefinition: [
+        app,
+        "candidateId",
+      ],
+      optional: false,
+    },
+    body: {
+      type: "string",
+      label: "body",
+      description: "The body of the note",
+    },
+    visibility: {
+      type: "string",
+      label: "Visibility",
+      description: "The visibility of the note",
+      options: [
+        "public",
+        "private",
+      ],
+      default: "public",
+    },
+  },
+  async run({ $ }) {
+    const payload = {
+      body: this.body,
+      visibility: {
+        level: this.visibility,
+      },
+    };
+    const response = await this.app.createNote({
+      $,
+      candidateId: this.candidateId,
+      data: {
+        note: payload,
+      },
+    });
+    $.export("$summary", `Successfully created note with ID \`${response.note.id}\``);
+    return response;
+  },
+};

package/actions/create-task/create-task.mjs

@@ -0,0 +1,65 @@
+import app from "../../recruitee.app.mjs";
+import timezones from "../common/timezones.mjs";
+
+export default {
+  name: "Create Task",
+  description: "Create a new task for a candidate. [See the documentation](https://api.recruitee.com/docs/index.html#task.web.task-task.web.task-post)",
+  key: "recruitee-create-task",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    app,
+    title: {
+      type: "string",
+      label: "Title",
+      description: "The task title",
+    },
+    candidateId: {
+      propDefinition: [
+        app,
+        "candidateId",
+      ],
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "The task description",
+      optional: true,
+    },
+    dueDate: {
+      type: "string",
+      label: "Due Date",
+      description: "The task due date. format as [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) e.g. `2023-11-15T08:30:00Z`",
+      optional: true,
+    },
+    timezone: {
+      type: "string",
+      label: "Timezone",
+      description: "The task timezone",
+      optional: true,
+      options: timezones,
+    },
+  },
+  async run({ $ }) {
+    const payload = {
+      candidate_id: this.candidateId,
+      description: this.description,
+      due_date: this.dueDate,
+      timezone: this.timezone,
+      title: this.title,
+    };
+    const response = await this.app.createTask({
+      $,
+      data: {
+        task: payload,
+      },
+    });
+    $.export("$summary", `Successfully created task with ID \`${response.task.id}\``);
+    return response;
+  },
+};

package/actions/list-candidate-id-options/list-candidate-id-options.mjs

@@ -0,0 +1,26 @@
+import recruitee from "../../recruitee.app.mjs";
+
+export default {
+  key: "recruitee-list-candidate-id-options",
+  name: "List Candidate ID Options",
+  description: "Retrieves available options for the Candidate ID field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    recruitee,
+  },
+  async run({ $ }) {
+    const options = await recruitee.propDefinitions.candidateId.options.call(this.recruitee, {});
+    $.export("$summary", `Successfully retrieved ${options.length} option${
+      options.length === 1
+        ? ""
+        : "s"
+    }`);
+    return options;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/recruitee",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream Recruitee Components",
   "main": "recruitee.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.6.8"
   }
 }

package/recruitee.app.mjs

@@ -1,11 +1,72 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "recruitee",
-  propDefinitions: {},
+  propDefinitions: {
+    candidateId: {
+      type: "integer",
+      label: "Candidate ID",
+      description: "The candidate unique identifier",
+      optional: true,
+      async options() {
+        const { candidates } = await this.listCandidates();
+        return candidates.map((candidate) => ({
+          label: candidate.name,
+          value: candidate.id,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _apiEndpoint() {
+      return "https://api.recruitee.com";
+    },
+    _authorization() {
+      return `Bearer ${this.$auth.api_token}`;
+    },
+    _companyId() {
+      return this.$auth.company_id;
+    },
+    _makeRequest({
+      $ = this, path, ...args
+    }) {
+      return axios($, {
+        url: `${this._apiEndpoint()}${path}`,
+        ...args,
+        headers: {
+          ...args.headers,
+          Authorization: this._authorization(),
+        },
+      });
+    },
+    listCandidates(args = {}) {
+      return this._makeRequest({
+        method: "GET",
+        path: `/c/${this.$auth.company_id}/candidates`,
+        ...args,
+      });
+    },
+    createTask(args = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/c/${this._companyId()}/tasks`,
+        ...args,
+      });
+    },
+    createNote(args = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/c/${this._companyId()}/candidates/${args.candidateId}/notes`,
+        ...args,
+      });
+    },
+    createCandidate(args = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/c/${this._companyId()}/candidates`,
+        ...args,
+      });
     },
   },
-};
+};

package/sources/new-candidate/new-candidate.mjs

@@ -0,0 +1,51 @@
+import app from "../../recruitee.app.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  key: "recruitee-new-candidate",
+  name: "New Candidate Created",
+  description: "Emit new event when a new candidate is created. [See the Documentation](https://api.recruitee.com/docs/index.html#candidate.web.candidate-candidate.web.candidate-get)",
+  type: "source",
+  version: "0.0.1",
+  dedupe: "unique",
+  props: {
+    app,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      static: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    emitEvent(data) {
+      this.$emit(data, {
+        id: data.id,
+        summary: `New candidate: "${data.name}"`,
+        ts: Date.parse(data.created_at),
+      });
+    },
+    _setLastCreatedAfter(timestamp) {
+      this.db.set("lastCreatedAfter", timestamp);
+    },
+    _getLastCreatedAfter() {
+      return this.db.get("lastCreatedAfter");
+    },
+  },
+  async run() {
+    const lastCreatedAfter = this._getLastCreatedAfter();
+    const {
+      candidates,
+      generated_at: generatedAt,
+    } = await this.app.listCandidates({
+      params: {
+        created_after: lastCreatedAfter,
+      },
+    });
+    this._setLastCreatedAfter(generatedAt);
+    for (const candidate of candidates) {
+      this.emitEvent(candidate);
+    }
+  },
+};