@pipedream/upkeep 0.0.4 → 0.1.0

package/README.md

@@ -1,31 +1,11 @@
 # Overview
 
-The [UpKeep API](https://www.upkeep.com/) allows developers to build
-Maintenance & Operations solutions for their customers and end users. The API
-enables developers to access data on their users' assets, tasks, and
-maintenance operations. With the UpKeep API, developers can build custom
-solutions for asset management, equipment tracking, work order management, and
-more.
+The UpKeep API enables users to seamlessly integrate maintenance management tasks with Pipedream's serverless execution platform. By leveraging UpKeep's endpoints, you can automate workflows related to asset tracking, work order management, and preventive maintenance scheduling. The API's capabilities allow for real-time updates on equipment status, automated notifications for maintenance tasks, and data synchronization across maintenance teams and tools.
 
-Some of the features that the UpKeep API provides include:
+# Example Use Cases
 
-- Asset Tracking: Track your assets with detailed information, such as location
-  and usage stats.
-- Task Management: Keep track of tasks assigned to your users or users assigned
-  to tasks.
-- Maintenance Operations: Record and track maintenance operations, such as
-  repairs and replacements.
-- Work Order Management: Create and manage work orders, including assigning
-  technicians and tracking progress.
+- **Automated Work Order Creation**: Trigger a new work order in UpKeep when a customer support ticket in Zendesk indicates equipment failure. This workflow can include pulling relevant customer data from the ticket, inputting it into the work order, and notifying the maintenance team in Slack.
 
-Here are some examples of what you can build using the UpKeep API:
+- **Preventive Maintenance Scheduling**: Use a cron job to schedule preventive maintenance tasks. The workflow can fetch equipment usage logs from an IoT platform, like Particle, evaluate if service is due, and create a maintenance request in UpKeep if thresholds are met.
 
-- Maintenance & Operations Solutions: Create solutions that manage equipment,
-  plan and schedule maintenance, record maintenance operations, and track asset
-  usage.
-- Fleet Management Solutions: Create solutions that track fleet assets,
-  including vehicles and equipment, and monitor usage.
-- Task Management Solutions: Create solutions that allow users to assign and
-  manage tasks, as well as track their progress.
-- Asset Tracking Solutions: Create solutions that track assets and their usage,
-  including their location, condition, and maintenance operations.
+- **Inventory Management Alerts**: Connect UpKeep with an inventory management app like TradeGecko to monitor stock levels. When inventory falls below a certain threshold, the workflow can automatically generate a purchase order in UpKeep and notify the procurement team via email or a messaging app like Microsoft Teams.

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

@@ -3,7 +3,12 @@ import common from "../common/common-purchase-order.mjs";
 export default {
   type: "action",
   key: "upkeep-create-purchase-order",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   name: "Create Purchase Order",
   description: "Create a Purchase Order, [See the docs](https://developers.onupkeep.com/#purchase-orders)",
   ...common,

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

@@ -3,7 +3,12 @@ import app from "../../upkeep.app.mjs";
 export default {
   type: "action",
   key: "upkeep-create-request",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   name: "Create Request",
   description: "Create a Request, [See the docs](https://developers.onupkeep.com/#create-a-request)",
   props: {

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

@@ -5,7 +5,12 @@ import { ConfigurationError } from "@pipedream/platform";
 export default {
   type: "action",
   key: "upkeep-create-work-order",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   name: "Create Work Order",
   description: "Create a Work Order, [See the docs](https://developers.onupkeep.com/#create-a-work-order)",
   props: {

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

@@ -4,7 +4,12 @@ import utils from "../../common/utils.mjs";
 export default {
   type: "action",
   key: "upkeep-find-asset",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   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: {

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

@@ -4,7 +4,12 @@ import utils from "../../common/utils.mjs";
 export default {
   type: "action",
   key: "upkeep-find-location",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   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: {

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

@@ -4,7 +4,12 @@ import utils from "../../common/utils.mjs";
 export default {
   type: "action",
   key: "upkeep-find-part",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   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: {

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

@@ -4,7 +4,12 @@ import utils from "../../common/utils.mjs";
 export default {
   type: "action",
   key: "upkeep-find-user",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   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: {

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

@@ -4,7 +4,12 @@ import utils from "../../common/utils.mjs";
 export default {
   type: "action",
   key: "upkeep-find-vendor",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   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: {

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

@@ -0,0 +1,33 @@
+import upkeep from "../../upkeep.app.mjs";
+
+export default {
+  key: "upkeep-list-asset-id-options",
+  name: "List Asset Options",
+  description: "Retrieves available options for the Asset field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    upkeep,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await upkeep.propDefinitions.assetId.options.call(this.upkeep, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

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

@@ -0,0 +1,33 @@
+import upkeep from "../../upkeep.app.mjs";
+
+export default {
+  key: "upkeep-list-category-id-options",
+  name: "List Category Options",
+  description: "Retrieves available options for the Category field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    upkeep,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await upkeep.propDefinitions.categoryId.options.call(this.upkeep, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/list-downtime-status-options/list-downtime-status-options.mjs

@@ -0,0 +1,33 @@
+import upkeep from "../../upkeep.app.mjs";
+
+export default {
+  key: "upkeep-list-downtime-status-options",
+  name: "List Downtime Status Options",
+  description: "Retrieves available options for the Downtime Status field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    upkeep,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await upkeep.propDefinitions.downtimeStatus.options.call(this.upkeep, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

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

@@ -0,0 +1,33 @@
+import upkeep from "../../upkeep.app.mjs";
+
+export default {
+  key: "upkeep-list-location-id-options",
+  name: "List Location Options",
+  description: "Retrieves available options for the Location field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    upkeep,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await upkeep.propDefinitions.locationId.options.call(this.upkeep, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/list-parts-options/list-parts-options.mjs

@@ -0,0 +1,33 @@
+import upkeep from "../../upkeep.app.mjs";
+
+export default {
+  key: "upkeep-list-parts-options",
+  name: "List Parts Options",
+  description: "Retrieves available options for the Parts field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    upkeep,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await upkeep.propDefinitions.parts.options.call(this.upkeep, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/list-purchase-order-id-options/list-purchase-order-id-options.mjs

@@ -0,0 +1,33 @@
+import upkeep from "../../upkeep.app.mjs";
+
+export default {
+  key: "upkeep-list-purchase-order-id-options",
+  name: "List Purchase Order Id Options",
+  description: "Retrieves available options for the Purchase Order Id field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    upkeep,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await upkeep.propDefinitions.purchaseOrderId.options.call(this.upkeep, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

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

@@ -0,0 +1,33 @@
+import upkeep from "../../upkeep.app.mjs";
+
+export default {
+  key: "upkeep-list-team-id-options",
+  name: "List Team Options",
+  description: "Retrieves available options for the Team field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    upkeep,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await upkeep.propDefinitions.teamId.options.call(this.upkeep, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

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

@@ -0,0 +1,33 @@
+import upkeep from "../../upkeep.app.mjs";
+
+export default {
+  key: "upkeep-list-user-id-options",
+  name: "List User Options",
+  description: "Retrieves available options for the User field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    upkeep,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await upkeep.propDefinitions.userId.options.call(this.upkeep, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

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

@@ -3,7 +3,12 @@ import common from "../common/common-purchase-order.mjs";
 export default {
   type: "action",
   key: "upkeep-update-purchase-order",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   name: "Update Purchase Order",
   description: "Update a Purchase Order, [See the docs](https://developers.onupkeep.com/#update-a-specific-purchase-order)",
   ...common,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/upkeep",
-  "version": "0.0.4",
+  "version": "0.1.0",
   "description": "Pipedream Upkeep Components",
   "main": "upkeep.app.mjs",
   "keywords": [
@@ -10,7 +10,7 @@
   "homepage": "https://pipedream.com/apps/upkeep",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "dependencies": {
-    "@pipedream/platform": "^1.1.1"
+    "@pipedream/platform": "^1.6.8"
   },
   "publishConfig": {
     "access": "public"