new source

Author: michelle0927

components/oxylabs/oxylabs.app.mjs

@@ -5,6 +5,15 @@ export default {
   type: "app",
   app: "oxylabs",
   propDefinitions: {
+    scheduleId: {
+      type: "string",
+      label: "Schedule ID",
+      description: "The ID of the schedule to watch",
+      async options() {
+        const { schedules } = await this.listSchedules();
+        return schedules || [];
+      },
+    },
     geoLocation: {
       type: "string",
       label: "Geo Location",
@@ -38,6 +47,12 @@ export default {
         ...opts,
       });
     },
+    listSchedules(opts = {}) {
+      return this._makeRequest({
+        path: "/schedules",
+        ...opts,
+      });
+    },
     async createSession({
       $ = this, proxyUrl, ...opts
     }) {
@@ -55,5 +70,13 @@ export default {
         ...opts,
       });
     },
+    getRunsInfo({
+      scheduleId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/schedules/${scheduleId}/runs`,
+        ...opts,
+      });
+    },
   },
 };

components/oxylabs/sources/new-scheduled-run-completed/new-scheduled-run-completed.mjs

@@ -0,0 +1,46 @@
+import oxylabs from "../../oxylabs.app.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  key: "oxylabs-new-scheduled-run-completed",
+  name: "New Scheduled Run Completed",
+  description: "Emit new event when a new scheduled run is completed. [See the documentation](https://developers.oxylabs.io/scraping-solutions/web-scraper-api/features/scheduler#get-runs-information)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    oxylabs,
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    scheduleId: {
+      propDefinition: [
+        oxylabs,
+        "scheduleId",
+      ],
+    },
+  },
+  methods: {
+    generateMeta(run) {
+      return {
+        id: run.id,
+        summary: `New Run with ID: ${run.id}`,
+        ts: Date.now(),
+      };
+    },
+  },
+  async run() {
+    const { runs } = await this.oxylabs.getRunsInfo({
+      scheduleId: this.scheduleId,
+    });
+    for (const run of runs) {
+      const meta = this.generateMeta(run);
+      this.$emit(run, meta);
+    }
+  },
+  sampleEmit,
+};

components/oxylabs/sources/new-scheduled-run-completed/test-event.mjs

@@ -0,0 +1,27 @@
+export default {
+  "run_id": 25037485,
+  "jobs": [
+    {
+      "id": 7300439540206948353,
+      "create_status_code": 202,
+      "result_status": "done",
+      "created_at": "2025-02-26 09:00:21",
+      "result_created_at": "2025-02-26 09:00:23",
+    },
+    {
+      "id": 7300439540169188353,
+      "create_status_code": 202,
+      "result_status": "done",
+      "created_at": "2025-02-26 09:00:21",
+      "result_created_at": "2025-02-26 09:00:22",
+    },
+    {
+      "id": 7300439540198551553,
+      "create_status_code": 202,
+      "result_status": "done",
+      "created_at": "2025-02-26 09:00:21",
+      "result_created_at": "2025-02-26 09:00:23",
+    },
+  ],
+  "success_rate": 1,
+};