@pipedream/qualiobee 0.0.1 → 0.1.0

package/actions/get-learner/get-learner.mjs

@@ -0,0 +1,31 @@
+import qualiobee from "../../qualiobee.app.mjs";
+
+export default {
+  key: "qualiobee-get-learner",
+  name: "Get Learner",
+  description: "Get a learner by UUID in Qualiobee. [See the documentation](https://app.qualiobee.fr/api/doc/#/Learner/PublicLearnerController_getOne)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    qualiobee,
+    learnerUuid: {
+      propDefinition: [
+        qualiobee,
+        "learnerUuid",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.qualiobee.getLearner({
+      $,
+      learnerUuid: this.learnerUuid,
+    });
+    $.export("$summary", `Successfully retrieved learner with UUID ${response.uuid}`);
+    return response;
+  },
+};

package/actions/list-modules/list-modules.mjs

@@ -0,0 +1,71 @@
+import qualiobee from "../../qualiobee.app.mjs";
+
+export default {
+  key: "qualiobee-list-modules",
+  name: "List Modules",
+  description: "List modules available in the Qualiobee organization. [See the documentation](https://app.qualiobee.fr/api/doc/#/Module/PublicModuleController_getMany)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    qualiobee,
+    withDeleted: {
+      type: "boolean",
+      label: "With Deleted",
+      description: "Whether to include deleted modules in the response",
+      optional: true,
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Filter by name",
+      optional: true,
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "Filter by description",
+      optional: true,
+    },
+    moduleUuid: {
+      propDefinition: [
+        qualiobee,
+        "moduleUuid",
+      ],
+      optional: true,
+    },
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page number to return",
+      optional: true,
+    },
+    limit: {
+      type: "integer",
+      label: "Limit",
+      description: "The maximum number of modules to return",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.qualiobee.listModules({
+      $,
+      params: {
+        withDeleted: this.withDeleted,
+        name: this.name,
+        description: this.description,
+        uuid: this.moduleUuid,
+        page: this.page,
+        limit: this.limit,
+      },
+    });
+    $.export("$summary", `Successfully listed ${response.data?.length} module${response.data?.length === 1
+      ? ""
+      : "s"}`);
+    return response;
+  },
+};

package/actions/update-customer/update-customer.mjs

@@ -0,0 +1,132 @@
+import qualiobee from "../../qualiobee.app.mjs";
+
+export default {
+  key: "qualiobee-update-customer",
+  name: "Update Customer",
+  description: "Update a customer in Qualiobee. [See the documentation](https://app.qualiobee.fr/api/doc/#/Customer/PublicCustomerController_updateOne)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    qualiobee,
+    customerUuid: {
+      propDefinition: [
+        qualiobee,
+        "customerUuid",
+      ],
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the company or the full name of the individual",
+      optional: true,
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "The first name of the referent in the company or the first name of the individual",
+      optional: true,
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "The last name of the referent in the company or the last name of the individual",
+      optional: true,
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The email of the customer",
+      optional: true,
+    },
+    phoneNumber: {
+      type: "string",
+      label: "Phone Number",
+      description: "The phone number of the customer",
+      optional: true,
+    },
+    note: {
+      type: "string",
+      label: "Note",
+      description: "A note about the customer",
+      optional: true,
+    },
+    isIndividual: {
+      type: "boolean",
+      label: "Is Individual",
+      description: "Whether the customer is an individual",
+      optional: true,
+    },
+    isSoloLearner: {
+      type: "boolean",
+      label: "Is Solo Learner",
+      description: "Whether the customer is a solo learner",
+      optional: true,
+    },
+    addressLine1: {
+      type: "string",
+      label: "Address Line 1",
+      description: "The first line of the address of the customer",
+      optional: true,
+    },
+    addressLine2: {
+      type: "string",
+      label: "Address Line 2",
+      description: "The second line of the address of the customer",
+      optional: true,
+    },
+    city: {
+      type: "string",
+      label: "City",
+      description: "The city of the address of the customer",
+      optional: true,
+    },
+    postalCode: {
+      type: "string",
+      label: "Postal Code",
+      description: "The postal code of the address of the customer",
+      optional: true,
+    },
+    country: {
+      type: "string",
+      label: "Country",
+      description: "The country of the address of the customer",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const hasLocation = this.addressLine1
+      || this.addressLine2
+      || this.city
+      || this.postalCode
+      || this.country;
+
+    const response = await this.qualiobee.updateCustomer({
+      $,
+      customerUuid: this.customerUuid,
+      data: {
+        name: this.name,
+        firstName: this.firstName,
+        lastName: this.lastName,
+        email: this.email,
+        phoneNumber: this.phoneNumber,
+        note: this.note,
+        isIndividual: this.isIndividual,
+        isSoloLearner: this.isSoloLearner,
+        location: hasLocation && {
+          addressLine1: this.addressLine1,
+          addressLine2: this.addressLine2,
+          city: this.city,
+          postalCode: this.postalCode,
+          country: this.country,
+        },
+      },
+    });
+    $.export("$summary", `Successfully updated customer with UUID ${response.uuid}`);
+    return response;
+  },
+};

package/package.json

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

package/qualiobee.app.mjs

@@ -1,11 +1,143 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "qualiobee",
-  propDefinitions: {},
+  propDefinitions: {
+    moduleUuid: {
+      type: "string",
+      label: "Module UUID",
+      description: "The UUID of a module",
+      async options({ page }) {
+        const { data } = await this.listModules({
+          params: {
+            page: page + 1,
+            limit: 100,
+          },
+        });
+        return data?.map(({
+          uuid, name,
+        }) => ({
+          value: uuid,
+          label: name,
+        })) || [];
+      },
+    },
+    customerUuid: {
+      type: "string",
+      label: "Customer UUID",
+      description: "The UUID of a customer",
+      async options({ page }) {
+        const { data } = await this.listCustomers({
+          params: {
+            page: page + 1,
+            limit: 100,
+          },
+        });
+        return data?.map(({
+          uuid, name,
+        }) => ({
+          value: uuid,
+          label: name,
+        })) || [];
+      },
+    },
+    learnerUuid: {
+      type: "string",
+      label: "Learner UUID",
+      description: "The UUID of a learner",
+      async options({ page }) {
+        const { data } = await this.listLearners({
+          params: {
+            page: page + 1,
+            limit: 100,
+          },
+        });
+        return data?.map(({
+          uuid, firstName, lastName,
+        }) => ({
+          value: uuid,
+          label: `${firstName} ${lastName}`,
+        })) || [];
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return `https://app.beehelp.fr/api/${this.$auth.organization_uuid}`;
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: {
+          "x-api-key": this.$auth.api_key,
+        },
+        ...opts,
+      });
+    },
+    getLearner({
+      learnerUuid, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/learner/${learnerUuid}`,
+        ...opts,
+      });
+    },
+    listModules(opts = {}) {
+      return this._makeRequest({
+        path: "/module",
+        ...opts,
+      });
+    },
+    listCustomers(opts = {}) {
+      return this._makeRequest({
+        path: "/customer",
+        ...opts,
+      });
+    },
+    listLearners(opts = {}) {
+      return this._makeRequest({
+        path: "/learner",
+        ...opts,
+      });
+    },
+    updateCustomer({
+      customerUuid, ...opts
+    }) {
+      return this._makeRequest({
+        method: "PATCH",
+        path: `/customer/${customerUuid}`,
+        ...opts,
+      });
+    },
+    async *paginate({
+      resourceFn, params, max,
+    }) {
+      params = {
+        ...params,
+        page: 1,
+        limit: 100,
+      };
+      let total, count = 0;
+      do {
+        const { data } = await resourceFn({
+          params,
+        });
+        if (!data?.length) {
+          return;
+        }
+        for (const item of data) {
+          yield item;
+          count++;
+          if (max && count >= max) {
+            return;
+          }
+        }
+        total = data?.length;
+        params.page++;
+      } while (total === params.limit);
     },
   },
-};
+};

package/sources/common/base-polling.mjs

@@ -0,0 +1,65 @@
+import qualiobee from "../../qualiobee.app.mjs";
+import {
+  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL, ConfigurationError,
+} from "@pipedream/platform";
+
+export default {
+  props: {
+    qualiobee,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastTs() {
+      return this.db.get("lastTs") || 0;
+    },
+    _setLastTs(lastTs) {
+      this.db.set("lastTs", lastTs);
+    },
+    getParams() {
+      return {};
+    },
+    getTsField() {
+      return "creationDate";
+    },
+    async processEvent(max) {
+      const lastTs = this._getLastTs();
+      let maxTs = lastTs;
+      const fn = this.getResourceFn();
+      const params = this.getParams();
+      const tsField = this.getTsField();
+      const results = this.qualiobee.paginate({
+        resourceFn: fn,
+        params,
+        max,
+      });
+      for await (const item of results) {
+        const ts = Date.parse(item[tsField]);
+        if (ts > lastTs) {
+          maxTs = Math.max(ts, maxTs);
+          this.$emit(item, this.generateMeta(item));
+        }
+      }
+      this._setLastTs(maxTs);
+    },
+    getResourceFn() {
+      throw new ConfigurationError("getResourceFn is not implemented");
+    },
+    generateMeta() {
+      throw new ConfigurationError("generateMeta is not implemented");
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.processEvent(10);
+    },
+  },
+  async run() {
+    await this.processEvent();
+  },
+};

package/sources/learner-updated/learner-updated.mjs

@@ -0,0 +1,28 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "qualiobee-learner-updated",
+  name: "Learner Updated",
+  description: "Emit new event when a learner is updated in Qualiobee. [See the documentation](https://app.qualiobee.fr/api/doc/#/Learner/PublicLearnerController_getMany)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.qualiobee.listLearners;
+    },
+    getTsField() {
+      return "updateDate";
+    },
+    generateMeta(learner) {
+      const ts = Date.parse(learner.updateDate);
+      return {
+        id: `${learner.uuid}-${ts}`,
+        summary: `Learner Updated with UUID ${learner.uuid}`,
+        ts,
+      };
+    },
+  },
+};

package/sources/new-customer-created/new-customer-created.mjs

@@ -0,0 +1,24 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "qualiobee-new-customer-created",
+  name: "New Customer Created",
+  description: "Emit new event when a new customer is created in Qualiobee. [See the documentation](https://app.qualiobee.fr/api/doc/#/Customer/PublicCustomerController_getMany)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.qualiobee.listCustomers;
+    },
+    generateMeta(customer) {
+      return {
+        id: customer.uuid,
+        summary: `New Customer with UUID ${customer.uuid}`,
+        ts: Date.parse(customer.creationDate),
+      };
+    },
+  },
+};

package/sources/new-learner-created/new-learner-created.mjs

@@ -0,0 +1,24 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "qualiobee-new-learner-created",
+  name: "New Learner Created",
+  description: "Emit new event when a new learner is created in Qualiobee. [See the documentation](https://app.qualiobee.fr/api/doc/#/Learner/PublicLearnerController_getMany)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.qualiobee.listLearners;
+    },
+    generateMeta(learner) {
+      return {
+        id: learner.uuid,
+        summary: `New Learner with UUID ${learner.uuid}`,
+        ts: Date.parse(learner.creationDate),
+      };
+    },
+  },
+};