@pipedream/upkeep 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/common/common-purchase-order.mjs

@@ -0,0 +1,93 @@
+import app from "../../upkeep.app.mjs";
+import utils from "../../common/utils.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  props: {
+    app,
+    vendorId: {
+      propDefinition: [
+        app,
+        "vendorId",
+      ],
+    },
+    categoryId: {
+      propDefinition: [
+        app,
+        "categoryId",
+      ],
+    },
+    purchaseOrderNumber: {
+      type: "string",
+      label: "Purchase Order Number",
+      description: "Set a custom purchase order number. If not passed, the default one from settings will be used.",
+      optional: true,
+    },
+    description: {
+      propDefinition: [
+        app,
+        "description",
+      ],
+    },
+    dueDate: {
+      type: "string",
+      label: "Due Date",
+      description: "Due date, in `yyyy-MM-dd` format, e.g. `2018-06-30`",
+      optional: true,
+    },
+    poDate: {
+      type: "string",
+      label: "Purchase Order Date",
+      description: "Date of purchase order, in `yyyy-MM-dd` format, e.g. `2018-06-28`",
+      optional: true,
+    },
+    parts: {
+      propDefinition: [
+        app,
+        "parts",
+      ],
+      description: "An array of Part IDs to include with the purchase order",
+    },
+    respectivePartQuantityUsed: {
+      propDefinition: [
+        app,
+        "respectivePartQuantityUsed",
+      ],
+    },
+    otherFields: {
+      type: "object",
+      label: "Other Fields",
+      description: "The fields does not exist in this integration. Please see (docs)[https://developers.onupkeep.com/#purchase-orders] for more fields, e.g. `{\"companyCity\":\"Los Angeles\",\"companyState\":\"California\",\"companyZip\":\"90224\"}`",
+      optional: true,
+    },
+    customFieldsPO: {
+      type: "string[]",
+      label: "Custom Fields",
+      description: "A list of custom fields of the purchase order. Its child attributes are `name`, `value`, and `unit`, e.g. `{\"name\": \"SAPPONumber\",\"value\": \"110-235\"}`",
+      optional: true,
+    },
+  },
+  methods: {
+    prepareData() {
+      if (this.parts.length != this.respectivePartQuantityUsed.length)
+        throw new ConfigurationError("`Respective Part Quantities`  and `Parts` must have the same length!");
+      const parts = [];
+      for (let i = 0; i < this.parts.length; i++) {
+        parts.push({
+          id: this.parts[i],
+          quantity: this.respectivePartQuantityUsed[i],
+        });
+      }
+      return {
+        title: this.title,
+        vendor: this.vendorId,
+        category: this.categoryId,
+        purchaseOrderNumber: parseInt(this.purchaseOrderNumber),
+        description: this.description,
+        parts,
+        customFieldsPO: utils.parseArray(this.customFieldsPO),
+        ...utils.parseObject(this.otherFields),
+      };
+    },
+  },
+};

package/actions/create-purchase-order/create-purchase-order.mjs

@@ -0,0 +1,28 @@
+import common from "../common/common-purchase-order.mjs";
+
+export default {
+  type: "action",
+  key: "upkeep-create-purchase-order",
+  version: "0.0.1",
+  name: "Create Purchase Order",
+  description: "Create a Purchase Order, [See the docs](https://developers.onupkeep.com/#purchase-orders)",
+  ...common,
+  props: {
+    app: common.props.app,
+    title: {
+      propDefinition: [
+        common.props.app,
+        "title",
+      ],
+    },
+    ...common.props,
+  },
+  async run ({ $ }) {
+    const { result } = await this.app.createPurchaseOrder({
+      $,
+      data: this.prepareData(),
+    });
+    $.export("$summary", `Purchase order with ID ${result.id} has been created.`);
+    return result;
+  },
+};

package/actions/create-request/create-request.mjs

@@ -0,0 +1,80 @@
+import app from "../../upkeep.app.mjs";
+
+export default {
+  type: "action",
+  key: "upkeep-create-request",
+  version: "0.0.1",
+  name: "Create Request",
+  description: "Create a Request, [See the docs](https://developers.onupkeep.com/#create-a-request)",
+  props: {
+    app,
+    title: {
+      propDefinition: [
+        app,
+        "title",
+      ],
+      description: "Title of the Request",
+    },
+    description: {
+      propDefinition: [
+        app,
+        "description",
+      ],
+      label: "Description",
+      description: "",
+    },
+    priority: {
+      propDefinition: [
+        app,
+        "priority",
+      ],
+    },
+    locationId: {
+      propDefinition: [
+        app,
+        "locationId",
+      ],
+    },
+    assetId: {
+      propDefinition: [
+        app,
+        "assetId",
+      ],
+    },
+    teamId: {
+      propDefinition: [
+        app,
+        "teamId",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+    },
+    dueDate: {
+      type: "string",
+      label: "Due Date",
+      description: "Due date, timestamp in milliseconds, e.g. `2018-01-09T07:20:22.310Z`",
+      optional: true,
+    },
+  },
+  async run ({ $ }) {
+    const { result } = await this.app.createRequest({
+      $,
+      data: {
+        title: this.title,
+        description: this.description,
+        priority: parseInt(this.priority),
+        location: this.locationId,
+        asset: this.assetId,
+        team: this.teamId,
+        assignedToUser: this.userId,
+        dueDate: this.dueDate,
+      },
+    });
+    $.export("$summary", `Request with ID ${result.id} has been created.`);
+    return result;
+  },
+};

package/actions/create-work-order/create-work-order.mjs

@@ -0,0 +1,133 @@
+import app from "../../upkeep.app.mjs";
+import utils from "../../common/utils.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  type: "action",
+  key: "upkeep-create-work-order",
+  version: "0.0.1",
+  name: "Create Work Order",
+  description: "Create a Work Order, [See the docs](https://developers.onupkeep.com/#create-a-work-order)",
+  props: {
+    app,
+    title: {
+      propDefinition: [
+        app,
+        "title",
+      ],
+      description: "Title of the work order",
+    },
+    description: {
+      propDefinition: [
+        app,
+        "description",
+      ],
+      label: "Description",
+      description: "",
+    },
+    priority: {
+      propDefinition: [
+        app,
+        "priority",
+      ],
+    },
+    category: {
+      type: "string",
+      label: "Category",
+      description: "One of the set categories for Work Orders on your account, including the default ones",
+      optional: true,
+    },
+    dueDate: {
+      type: "string",
+      label: "Due Date",
+      description: "Due date, in ISO 8601 format, e.g. `2022-09-07` or `2022-09-07T13:26:53`",
+      optional: true,
+    },
+    assetId: {
+      propDefinition: [
+        app,
+        "assetId",
+      ],
+    },
+    locationId: {
+      propDefinition: [
+        app,
+        "locationId",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+    },
+    parts: {
+      propDefinition: [
+        app,
+        "parts",
+      ],
+    },
+    respectivePartQuantityUsed: {
+      propDefinition: [
+        app,
+        "respectivePartQuantityUsed",
+      ],
+    },
+    decreaseInventory: {
+      type: "string",
+      label: "Decrease Inventory",
+      description: "Can be `auto` or `manual`. Default is `auto`. If set to `auto`, inventory will be automatically be decreased when a part is added to a work order. If set to `manual`, inventory will NOT be decreased when a part is added to a work order.",
+      optional: true,
+      options: [
+        "manual",
+        "auto",
+      ],
+    },
+    time: {
+      type: "integer",
+      label: "Time",
+      description: "The total time spent on the work order",
+      optional: true,
+    },
+    cost: {
+      type: "integer",
+      label: "Cost",
+      description: "The additional cost assigned to the work order",
+      optional: true,
+    },
+    additionalUsers: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+      type: "string[]",
+      description: "An array of user IDs for additional workers assigned to the work order.",
+    },
+  },
+  async run ({ $ }) {
+    const dueDate = Date.parse(this.dueDate);
+    if (isNaN(dueDate))
+      throw new ConfigurationError("Due Date should be in ISO 8601 format!");
+    const { result } = await this.app.createWorkOrder({
+      $,
+      data: {
+        title: this.title,
+        description: this.description,
+        priority: parseInt(this.priority),
+        category: this.category,
+        dueDate,
+        asset: this.assetId,
+        location: this.locationId,
+        assignedToUser: this.userId,
+        parts: this.parts,
+        respectivePartQuantityUsed: utils.parseArray(this.respectivePartQuantityUsed),
+        decreaseInventory: this.decreaseInventory,
+        time: parseInt(this.time),
+        cost: parseInt(this.cost),
+        additionalUsers: this.additionalUsers,
+      },
+    });
+    $.export("$summary", `Request with ID ${result.id} has been created.`);
+    return result;
+  },
+};

package/actions/find-asset/find-asset.mjs

@@ -0,0 +1,92 @@
+import app from "../../upkeep.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  type: "action",
+  key: "upkeep-find-asset",
+  version: "0.0.1",
+  name: "Find Asset",
+  description: "Finds assets according to props configured, if no prop configured returns all assets, [See the docs](https://developers.onupkeep.com/#get-all-assets)",
+  props: {
+    app,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "If set, the result will only include assets with that name.",
+      optional: true,
+    },
+    locationId: {
+      propDefinition: [
+        app,
+        "locationId",
+      ],
+      description: "The ID of the location. If set, the result will only include assets assigned to this location.",
+    },
+    status: {
+      type: "string",
+      label: "Status",
+      description: "If set, the result will only include assets with this status.",
+      optional: true,
+      options: [
+        {
+          label: "Operational",
+          value: "active",
+        },
+        {
+          label: "Not Operational",
+          value: "inactive",
+        },
+      ],
+    },
+    category: { //no method to fetch asset categories
+      type: "string",
+      label: "Category",
+      description: "If set, the result will only include assets with this category.",
+      optional: true,
+    },
+    userId: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+      description: "The ID of the user. If set, the result will only include assets assigned to this user.",
+    },
+    createdByUser: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+      label: "Created By User",
+      description: "The ID of the user. If set, the result will only include assets created by this user.",
+    },
+    downtimeStatus: {
+      propDefinition: [
+        app,
+        "downtimeStatus",
+      ],
+    },
+  },
+  async run ({ $ }) {
+    const items = [];
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.getAssets,
+      resourceFnArgs: {
+        $,
+        params: {
+          name: this.name,
+          location: this.locationId,
+          status: this.status,
+          category: this.category,
+          assignedToUser: this.userId,
+          createdByUser: this.createdByUser,
+          downtimeStatus: this.downtimeStatus,
+        },
+      },
+    });
+    for await (const item of resourcesStream)
+      items.push(item);
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${items.length} asset${items.length != 1 ? "s" : ""} has been found.`);
+    return items;
+  },
+};

package/actions/find-location/find-location.mjs

@@ -0,0 +1,54 @@
+import app from "../../upkeep.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  type: "action",
+  key: "upkeep-find-location",
+  version: "0.0.1",
+  name: "Find Location",
+  description: "Finds locations according to props configured, if no prop configured returns all locations, [See the docs](https://developers.onupkeep.com/#get-all-locations)",
+  props: {
+    app,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "If set, the result will only include locations with that name.",
+      optional: true,
+    },
+    locationId: {
+      propDefinition: [
+        app,
+        "locationId",
+      ],
+      label: "Parent Location",
+      description: "If set, the result will only include sub locations of this parent location.",
+    },
+    createdByUser: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+      label: "Created By User",
+      description: "If set, the result will only include locations created by this user.",
+    },
+  },
+  async run ({ $ }) {
+    const items = [];
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.getLocations,
+      resourceFnArgs: {
+        $,
+        params: {
+          name: this.name,
+          parentLocation: this.locationId,
+          createdByUser: this.createdByUser,
+        },
+      },
+    });
+    for await (const item of resourcesStream)
+      items.push(item);
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${items.length} location${items.length != 1 ? "s" : ""} has been found.`);
+    return items;
+  },
+};

package/actions/find-part/find-part.mjs

@@ -0,0 +1,60 @@
+import app from "../../upkeep.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  type: "action",
+  key: "upkeep-find-part",
+  version: "0.0.1",
+  name: "Find Part",
+  description: "Finds parts according to props configured, if no prop configured returns all parts, [See the docs](https://developers.onupkeep.com/#get-all-parts)",
+  props: {
+    app,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "If set, the result will only include parts with that name.",
+      optional: true,
+    },
+    category: { //no method to fetch part categories
+      type: "string",
+      label: "Category",
+      description: "If set, the result will only include parts with that category.",
+      optional: true,
+    },
+    locationId: {
+      propDefinition: [
+        app,
+        "locationId",
+      ],
+      description: "The ID of the location. If set, the result will only include parts assigned to this location.",
+    },
+    createdByUser: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+      label: "Created By User",
+      description: "The ID of the user. If set, the result will only include parts created by this user.",
+    },
+  },
+  async run ({ $ }) {
+    const items = [];
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.getParts,
+      resourceFnArgs: {
+        $,
+        params: {
+          name: this.name,
+          category: this.category,
+          location: this.locationId,
+          createdByUser: this.createdByUser,
+        },
+      },
+    });
+    for await (const item of resourcesStream)
+      items.push(item);
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${items.length} part${items.length != 1 ? "s" : ""} has been found.`);
+    return items;
+  },
+};

package/actions/find-user/find-user.mjs

@@ -0,0 +1,43 @@
+import app from "../../upkeep.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  type: "action",
+  key: "upkeep-find-user",
+  version: "0.0.1",
+  name: "Find User",
+  description: "Finds users according to props configured, if no prop configured returns all users, [See the docs](https://developers.onupkeep.com/#get-all-users)",
+  props: {
+    app,
+    email: {
+      type: "string",
+      label: "Email",
+      description: "If set, the result will only include user with that email.",
+      optional: true,
+    },
+    accountType: { //no method to fetch account types
+      type: "string",
+      label: "Category",
+      description: "If set, the result will only include user with that account type.",
+      optional: true,
+    },
+  },
+  async run ({ $ }) {
+    const items = [];
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.getUsers,
+      resourceFnArgs: {
+        $,
+        params: {
+          email: this.email,
+          accountType: this.accountType,
+        },
+      },
+    });
+    for await (const item of resourcesStream)
+      items.push(item);
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${items.length} user${items.length != 1 ? "s" : ""} has been found.`);
+    return items;
+  },
+};

package/actions/find-vendor/find-vendor.mjs

@@ -0,0 +1,36 @@
+import app from "../../upkeep.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  type: "action",
+  key: "upkeep-find-vendor",
+  version: "0.0.1",
+  name: "Find Vendor",
+  description: "Finds vendors according to props configured, if no prop configured returns all vendors. Note: enterprise/business-plus plan access only. [See the docs](https://developers.onupkeep.com/#get-all-vendors)",
+  props: {
+    app,
+    businessName: {
+      type: "string",
+      label: "Business Name",
+      description: "If set, the result will only include vendors with that business name.",
+      optional: true,
+    },
+  },
+  async run ({ $ }) {
+    const items = [];
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.getVendors,
+      resourceFnArgs: {
+        $,
+        params: {
+          businessName: this.businessName,
+        },
+      },
+    });
+    for await (const item of resourcesStream)
+      items.push(item);
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${items.length} vendor${items.length != 1 ? "s" : ""} has been found.`);
+    return items;
+  },
+};

package/actions/update-purchase-order/update-purchase-order.mjs

@@ -0,0 +1,36 @@
+import common from "../common/common-purchase-order.mjs";
+
+export default {
+  type: "action",
+  key: "upkeep-update-purchase-order",
+  version: "0.0.1",
+  name: "Update Purchase Order",
+  description: "Update a Purchase Order, [See the docs](https://developers.onupkeep.com/#update-a-specific-purchase-order)",
+  ...common,
+  props: {
+    app: common.props.app,
+    purchaseOrderId: {
+      propDefinition: [
+        common.props.app,
+        "purchaseOrderId",
+      ],
+    },
+    title: {
+      propDefinition: [
+        common.props.app,
+        "title",
+      ],
+      optional: true,
+    },
+    ...common.props,
+  },
+  async run ({ $ }) {
+    const { result } = await this.app.updatePurchaseOrder({
+      $,
+      purchaseOrderId: this.purchaseOrderId,
+      data: this.prepareData(),
+    });
+    $.export("$summary", `Purchase order with ID ${result.id} has been updated.`);
+    return result;
+  },
+};