@pipedream/postman 0.1.0 → 0.3.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Postman API enables you to automate tasks within your Postman collections, such as running collections, fetching and updating environments, and integrating your API development workflow into your CI/CD pipeline. Using Pipedream, you can harness this functionality to create custom workflows that trigger on various events, process data, and connect with other apps, extending the capabilities of your API testing and development processes.
+
+# Example Use Cases
+
+- **Scheduled Collection Runs**: Use Pipedream to schedule and run Postman collections at regular intervals. You can analyze the results, send alerts if a test fails, or even trigger other workflows based on those results.
+
+- **Dynamic Environment Updates**: Automatically update Postman environment variables when changes occur in your apps. For instance, sync new user data from a CRM platform to Postman's environment, ensuring your API tests always use the latest data.
+
+- **CI/CD Integration**: Connect your Postman tests with your CI/CD pipeline. After every code commit, use Pipedream to trigger a workflow that runs a specific Postman collection and reports the status back to your CI/CD tool, such as GitHub Actions, ensuring that only tested code gets deployed.

package/actions/create-environment/create-environment.mjs

@@ -4,7 +4,12 @@ export default {
   key: "postman-create-environment",
   name: "Create Environment",
   description: "Creates a new environment in Postman. [See the documentation](https://learning.postman.com/docs/developer/postman-api/intro-api/)",
-  version: "0.0.1",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     postman,

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

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

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

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

package/actions/run-monitor/run-monitor.mjs

@@ -4,7 +4,12 @@ export default {
   key: "postman-run-monitor",
   name: "Run Monitor",
   description: "Run a specific monitor in Postman. [See the documentation](https://learning.postman.com/docs/developer/postman-api/intro-api/)",
-  version: "0.0.1",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     postman,

package/actions/update-variable/update-variable.mjs

@@ -4,7 +4,12 @@ export default {
   key: "postman-update-variable",
   name: "Update Environment Variable",
   description: "Updates a specific environment variable in Postman. [See the documentation](https://learning.postman.com/docs/developer/postman-api/intro-api/)",
-  version: "0.0.1",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     postman,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/postman",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Pipedream Postman Components",
   "main": "postman.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.5.1"
+    "@pipedream/platform": "^1.6.8"
   }
 }