Jobber - Search & Filter Quotes (#17263)

* new components

* pnpm-lock.yaml

* fix page size

* remove console.log

* updates

Author: michelle0927

components/jobber/actions/create-client/create-client.mjs

@@ -5,7 +5,7 @@ export default {
   key: "jobber-create-client",
   name: "Create Client",
   description: "Generates a new client within Jobber. [See the documentation](https://developer.getjobber.com/docs)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   props: {
     jobber,

components/jobber/actions/create-quote/create-quote.mjs

@@ -4,7 +4,7 @@ export default {
   key: "jobber-create-quote",
   name: "Create Quote",
   description: "Generates a new quote for a client's property in Jobber. [See the documentation](https://developer.getjobber.com/docs/)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   props: {
     jobber,

components/jobber/actions/create-request/create-request.mjs

@@ -6,7 +6,7 @@ export default {
   key: "jobber-create-request",
   name: "Create Service Request",
   description: "Creates a new service request for a client's first property within Jobber. [See the documentation](https://developer.getjobber.com/docs/)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   props: {
     jobber,

components/jobber/actions/filter-quotes/filter-quotes.mjs

@@ -0,0 +1,94 @@
+import jobber from "../../jobber.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "jobber-filter-quotes",
+  name: "Filter Quotes",
+  description: "Filter quotes by status, quote number, or cost in Jobber. [See the documentation](https://developer.getjobber.com/docs)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    jobber,
+    status: {
+      type: "string",
+      label: "Status",
+      description: "The status to filter quotes by",
+      options: [
+        "draft",
+        "awaiting_response",
+        "archived",
+        "approved",
+        "converted",
+        "changes_requested",
+      ],
+      optional: true,
+    },
+    clientId: {
+      propDefinition: [
+        jobber,
+        "clientId",
+      ],
+      description: "The client ID to filter quotes by",
+      optional: true,
+    },
+    quoteNumber: {
+      type: "string",
+      label: "Quote Number",
+      description: "The quote number to filter quotes by",
+      optional: true,
+    },
+    cost: {
+      type: "string",
+      label: "Cost",
+      description: "The cost to filter quotes by",
+      optional: true,
+    },
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: "The maximum number of results to return",
+      default: 100,
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const query = `query FilterQuotes($first: Int, $after: String, $filter: QuoteFilterAttributes) {
+      quotes(first: $first, after: $after, filter: $filter) {
+        nodes {
+          ${constants.QUOTE_FIELDS}
+        }
+        pageInfo {
+          endCursor
+          hasNextPage
+        }
+      }
+    }`;
+
+    const args = {
+      filter: {
+        status: this.status,
+        clientId: this.clientId,
+        quoteNumber: this.quoteNumber
+          ? {
+            eq: +this.quoteNumber,
+          }
+          : undefined,
+        cost: this.cost
+          ? {
+            eq: +this.cost,
+          }
+          : undefined,
+      },
+    };
+    const quotes = await this.jobber.getPaginatedResources({
+      query,
+      args,
+      resourceKey: "quotes",
+      max: this.maxResults,
+    });
+    $.export("$summary", `Successfully found ${quotes.length} quote${quotes.length === 1
+      ? ""
+      : "s"}`);
+    return quotes;
+  },
+};

components/jobber/actions/search-quotes/search-quotes.mjs

@@ -0,0 +1,53 @@
+import jobber from "../../jobber.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "jobber-search-quotes",
+  name: "Search Quotes",
+  description: "Search for quotes using a search termin Jobber. [See the documentation](https://developer.getjobber.com/docs)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    jobber,
+    searchTerm: {
+      type: "string",
+      label: "Search Term",
+      description: "The search term to use to filter quotes",
+      optional: true,
+    },
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: "The maximum number of results to return",
+      default: 100,
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const query = `query SearchQuotes($first: Int, $after: String, $searchTerm: String) {
+      quotes(first: $first, after: $after, searchTerm: $searchTerm) {
+        nodes {
+          ${constants.QUOTE_FIELDS}
+        }
+        pageInfo {
+          endCursor
+          hasNextPage
+        }
+      }
+    }`;
+
+    const args = {
+      searchTerm: this.searchTerm,
+    };
+    const quotes = await this.jobber.getPaginatedResources({
+      query,
+      args,
+      resourceKey: "quotes",
+      max: this.maxResults,
+    });
+    $.export("$summary", `Successfully found ${quotes.length} quote${quotes.length === 1
+      ? ""
+      : "s"}`);
+    return quotes;
+  },
+};

components/jobber/common/constants.mjs

@@ -0,0 +1,44 @@
+const QUOTE_FIELDS = `
+  id
+  title
+  amounts {
+    total
+  }
+  client {
+    id
+    name
+  }
+  clientHubUri
+  clientHubViewedAt
+  contractDisclaimer
+  createdAt
+  depositAmountUnallocated
+  jobberWebUri
+  jobs {
+    nodes {
+      id
+      title
+    }
+  }
+  lineItems {
+    nodes {
+      id
+      category
+      name
+      quantity
+      totalPrice
+    }
+  }
+  message
+  quoteNumber
+  quoteStatus
+  salesperson {
+    id
+  }
+  transitionedAt
+  updatedAt
+`;
+
+export default {
+  QUOTE_FIELDS,
+};

components/jobber/jobber.app.mjs

@@ -1,4 +1,6 @@
-import { axios } from "@pipedream/platform";
+import {
+  axios, ConfigurationError,
+} from "@pipedream/platform";
 
 export default {
   type: "app",
@@ -66,20 +68,25 @@ export default {
     _baseUrl() {
       return "https://api.getjobber.com/api";
     },
-    _makeRequest(opts = {}) {
+    async _makeRequest(opts = {}) {
       const {
         $ = this,
         path,
         ...otherOpts
       } = opts;
-      return axios($, {
+      const response = await axios($, {
         ...otherOpts,
         url: `${this._baseUrl()}${path}`,
         headers: {
           "Authorization": `Bearer ${this.$auth.oauth_access_token}`,
           "X-JOBBER-GRAPHQL-VERSION": "2025-01-20",
         },
       });
+      if (response.errors) {
+        console.log(JSON.stringify(response, null, 2));
+        throw new ConfigurationError(response.errors[0].message);
+      }
+      return response;
     },
     post(opts = {}) {
       return this._makeRequest({
@@ -88,5 +95,49 @@ export default {
         ...opts,
       });
     },
+    async *paginate({
+      query,
+      args = {},
+      resourceKey,
+      max,
+    }) {
+      let counter = 0;
+      let hasNextPage;
+      let endCursor;
+      do {
+        const variables = {
+          after: endCursor,
+          first: 10,
+          ...args,
+        };
+        const { data } = await this.post({
+          data: {
+            query,
+            variables,
+          },
+        });
+        const {
+          nodes, pageInfo,
+        } = data[resourceKey];
+        if (!nodes?.length) {
+          return;
+        }
+        for (const node of nodes) {
+          counter += 1;
+          yield node;
+        }
+        ({
+          hasNextPage, endCursor,
+        } = pageInfo);
+      } while (hasNextPage && counter < max);
+    },
+    async getPaginatedResources(args) {
+      const results = [];
+      const resources = this.paginate(args);
+      for await (const resource of resources) {
+        results.push(resource);
+      }
+      return results;
+    },
   },
 };

components/jobber/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/jobber",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Pipedream Jobber Components",
   "main": "jobber.app.mjs",
   "keywords": [