@pipedream/everstox 0.0.1 → 0.2.0

package/actions/get-order/get-order.mjs

@@ -0,0 +1,33 @@
+import everstox from "../../everstox.app.mjs";
+
+export default {
+  key: "everstox-get-order",
+  name: "Get Order",
+  description: "Get an order from Everstox. [See the documentation](https://api.everstox.com/api/v1/ui/#/Order/district_core.api.shops.orders.orders.Orders.get)",
+  version: "0.0.2",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    everstox,
+    orderId: {
+      propDefinition: [
+        everstox,
+        "orderId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.everstox.getOrder({
+      $,
+      orderId: this.orderId,
+    });
+
+    $.export("$summary", `Successfully retrieved order with ID \`${this.orderId}\`.`);
+
+    return response;
+  },
+};

package/actions/get-return/get-return.mjs

@@ -0,0 +1,31 @@
+import everstox from "../../everstox.app.mjs";
+
+export default {
+  key: "everstox-get-return",
+  name: "Get Return",
+  description: "Get a return from Everstox. [See the documentation](https://api.everstox.com/api/v1/ui/#/Returns%20V2/district_core.api.shops.returns_v2.returns_v2.ReturnsV2.get)",
+  version: "0.0.2",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    everstox,
+    returnId: {
+      propDefinition: [
+        everstox,
+        "returnId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.everstox.getReturn({
+      $,
+      returnId: this.returnId,
+    });
+    $.export("$summary", `Successfully retrieved return with ID \`${this.returnId}\`.`);
+    return response;
+  },
+};

package/actions/list-returns/list-returns.mjs

@@ -0,0 +1,110 @@
+import everstox from "../../everstox.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "everstox-list-returns",
+  name: "List Returns",
+  description: "List returns from Everstox. [See the documentation](https://api.everstox.com/api/v1/ui/#/Returns%20V2/district_core.api.shops.returns_v2.returns_v2.ReturnsV2.index)",
+  version: "0.0.2",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    everstox,
+    orderNumber: {
+      propDefinition: [
+        everstox,
+        "orderNumber",
+      ],
+      optional: true,
+    },
+    rmaNumber: {
+      type: "string",
+      label: "RMA Number",
+      description: "Filter by RMA number",
+      optional: true,
+    },
+    updatedDateGte: {
+      type: "string",
+      label: "Updated Date Greater Than or Equal To",
+      description: "Filter returns with updated date greater than or equal to the provided date. Example: `2021-02-23`",
+      optional: true,
+    },
+    updatedDateLte: {
+      type: "string",
+      label: "Updated Date Less Than or Equal To",
+      description: "Filter returns with updated date less than or equal to the provided date. Example: `2021-02-23`",
+      optional: true,
+    },
+    createdDateGte: {
+      type: "string",
+      label: "Created Date Greater Than or Equal To",
+      description: "Filter returns with created date greater than or equal to the provided date. Example: `2021-02-23`",
+      optional: true,
+    },
+    createdDateLte: {
+      type: "string",
+      label: "Created Date Less Than or Equal To",
+      description: "Filter returns with created date less than or equal to the provided date. Example: `2021-02-23`",
+      optional: true,
+    },
+    returnReviewed: {
+      type: "boolean",
+      label: "Return Reviewed",
+      description: "Filter returns by return reviewed status",
+      optional: true,
+    },
+    productSku: {
+      type: "string",
+      label: "Product SKU",
+      description: "Filter returns by product SKU",
+      optional: true,
+    },
+    limit: {
+      type: "integer",
+      label: "Limit",
+      description: "The number of items to return (default 10)",
+      optional: true,
+    },
+    offset: {
+      type: "integer",
+      label: "Offset",
+      description: "The number of items to skip before starting to collect the result set",
+      optional: true,
+    },
+    orderBy: {
+      type: "string",
+      label: "Order By",
+      description: "The field to order by",
+      options: constants.ORDER_BY_OPTIONS,
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.everstox.listReturns({
+      $,
+      params: {
+        order_number: this.orderNumber,
+        stategroup: "all",
+        rma_num: this.rmaNumber,
+        updated_date_gte: this.updatedDateGte,
+        updated_date_lte: this.updatedDateLte,
+        creation_date_gte: this.createdDateGte,
+        creation_date_lte: this.createdDateLte,
+        return_reviewed: this.returnReviewed,
+        product_sku: this.productSku,
+        limit: this.limit,
+        offset: this.offset,
+        order_by: this.orderBy,
+        exact_search: false,
+      },
+    });
+    $.export("$summary", `Successfully retrieved ${response.items.length} return${response.items.length === 1
+      ? ""
+      : "s"}`);
+    return response;
+  },
+};

package/actions/search-orders/search-orders.mjs

@@ -0,0 +1,145 @@
+import constants from "../../common/constants.mjs";
+import everstox from "../../everstox.app.mjs";
+
+export default {
+  key: "everstox-search-orders",
+  name: "Search Orders by Order Number",
+  description: "Search orders from Everstox. [See the documentation](https://api.everstox.com/api/v1/ui/#/Order/district_core.api.shops.orders.orders.Orders.index)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    everstox,
+    warehouseIds: {
+      propDefinition: [
+        everstox,
+        "warehouseIds",
+      ],
+      optional: true,
+    },
+    fields: {
+      propDefinition: [
+        everstox,
+        "fields",
+      ],
+      type: "string[]",
+      label: "Fields",
+      description: "Fields to filter for",
+      optional: true,
+    },
+    orderNumber: {
+      propDefinition: [
+        everstox,
+        "orderNumber",
+      ],
+      description: "Filter for order number",
+      optional: true,
+    },
+    hoursLateLte: {
+      type: "integer",
+      label: "Hours Late Less Than or Equal to",
+      description: "Filter for orders late for the amount of hours less or equal than the provided value",
+      optional: true,
+    },
+    hoursLateGte: {
+      type: "integer",
+      label: "Hours Late Greater Than or Equal to",
+      description: "Filter for orders late for the amount of hours greater or equal than the provided value",
+      optional: true,
+    },
+    search: {
+      type: "string",
+      label: "Search",
+      description: "Multi-attribute-search filters either for Customer Email or Billing Address or Order Number. Returns set of orders where at least one of those attributes match the search term",
+      optional: true,
+    },
+    fulfillmentState: {
+      type: "string",
+      label: "Fulfillment State",
+      description: "Fulfillment State to filter for order where the corresponding fulfillment is in the given state",
+      options: constants.FULFILLMENT_STATE_OPTIONS,
+      optional: true,
+    },
+    fulfillmentStategroup: {
+      type: "string",
+      label: "Fulfillment Stategroup",
+      description: "Fulfillment Stategroup to filter for order where the corresponding fulfillment is in the given stategroup",
+      options: constants.FULFILLMENT_STATEGROUP_OPTIONS,
+      optional: true,
+    },
+    stategroup: {
+      type: "string",
+      label: "Stategroup",
+      description: "Stategroup to filter for, e.g. open includes states like new, in_progress etc",
+      options: constants.STATEGROUP_OPTIONS,
+      optional: true,
+    },
+    cancellationState: {
+      type: "string",
+      label: "Cancellation State",
+      description: "Cancellation State to filter for order with min 1 cancellation in that state",
+      options: constants.CANCELLATION_STATE_OPTIONS,
+      optional: true,
+    },
+    shipmentDateGte: {
+      type: "string",
+      label: "Shipment Date Greater Than or Equal",
+      description: "Find orders whose shipment date is greater than or equal to the provided value",
+      optional: true,
+    },
+    updatedDateGte: {
+      type: "string",
+      label: "Updated Date Greater Than or Equal",
+      description: "Find orders whose updated date is greater than or equal to the provided value",
+      optional: true,
+    },
+    createdDateGte: {
+      type: "string",
+      label: "Created Date Greater Than or Equal",
+      description: "Find orders whose creation date is greater than or equal to the provided value",
+      optional: true,
+    },
+    createdDateLte: {
+      type: "string",
+      label: "Created Date Less Than or Equal",
+      description: "Find orders whose created date is less than or equal to the provided value",
+      optional: true,
+    },
+    shipmentsForwardedToShop: {
+      type: "boolean",
+      label: "Shipments Forwarded to Shop",
+      description: "Boolean returning orders with shipments forwarded to shop",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.everstox.listOrders({
+      $,
+      params: {
+        warehouse_ids: this.warehouseIds,
+        fields: this.fields,
+        order_number: this.orderNumber,
+        hours_late_lte: this.hoursLateLte,
+        hours_late_gte: this.hoursLateGte,
+        search: this.search,
+        fulfillment_state: this.fulfillmentState,
+        fulfillment_stategroup: this.fulfillmentStategroup,
+        stategroup: this.stategroup,
+        cancellation_state: this.cancellationState,
+        shipment_date_gte: this.shipmentDateGte,
+        updated_date_gte: this.updatedDateGte,
+        created_date_gte: this.createdDateGte,
+        created_date_lte: this.createdDateLte,
+        shipments_forwarded_to_shop: this.shipmentsForwardedToShop,
+      },
+    });
+    $.export("$summary", `Successfully retrieved ${response.items.length} return${response.items.length === 1
+      ? ""
+      : "s"}`);
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,52 @@
+const LIMIT = 100;
+
+const ORDER_BY_OPTIONS = [
+  "creation_date",
+  "order_number",
+  "rma_number",
+];
+
+const FULFILLMENT_STATE_OPTIONS = [
+  "new",
+  "created",
+  "warehouse_confirmation_pending",
+  "accepted_by_connector",
+  "accepted_by_warehouse",
+  "rejected_by_warehouse",
+  "in_fulfillment",
+  "partially_shipped",
+  "shipped",
+  "cancelled",
+];
+
+const FULFILLMENT_STATEGROUP_OPTIONS = [
+  "open",
+  "canceled",
+  "completed",
+  "all",
+];
+
+const STATEGROUP_OPTIONS = [
+  "open",
+  "closed",
+  "requires_attention",
+  "all",
+];
+
+const CANCELLATION_STATE_OPTIONS = [
+  "new",
+  "rejected",
+  "connector_confirmation_pending",
+  "accepted_by_connector",
+  "warehouse_cancellation_pending",
+  "completed",
+];
+
+export default {
+  LIMIT,
+  ORDER_BY_OPTIONS,
+  FULFILLMENT_STATE_OPTIONS,
+  FULFILLMENT_STATEGROUP_OPTIONS,
+  STATEGROUP_OPTIONS,
+  CANCELLATION_STATE_OPTIONS,
+};

package/everstox.app.mjs

@@ -1,11 +1,135 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+const LIMIT = constants.LIMIT;
+
 export default {
   type: "app",
   app: "everstox",
-  propDefinitions: {},
+  propDefinitions: {
+    warehouseIds: {
+      type: "string[]",
+      label: "Warehouse IDs",
+      description: "Warehouse IDs",
+      async options({ page }) {
+        const { items } = await this.listWarehouses({
+          params: {
+            limit: LIMIT,
+            offset: page * LIMIT,
+          },
+        });
+        return items?.map(({
+          id, name,
+        }) => ({
+          label: name,
+          value: id,
+        })) || [];
+      },
+    },
+    orderId: {
+      type: "string",
+      label: "Order ID",
+      description: "The ID of the order",
+      async options({ page }) {
+        const { items } = await this.listOrders({
+          params: {
+            limit: LIMIT,
+            offset: page * LIMIT,
+          },
+        });
+        return items?.map(({
+          id, order_number: orderNumber,
+        }) => ({
+          label: `Order Number: ${orderNumber}`,
+          value: id,
+        })) || [];
+      },
+    },
+    orderNumber: {
+      type: "string",
+      label: "Order Number",
+      description: "The number of the order",
+      async options({ page }) {
+        const { items } = await this.listOrders({
+          params: {
+            limit: LIMIT,
+            offset: page * LIMIT,
+          },
+        });
+        return items?.map(({ order_number: orderNumber }) => ({
+          label: `Order ${orderNumber}`,
+          value: orderNumber.replace(/^#/, ""),
+        })) || [];
+      },
+    },
+    returnId: {
+      type: "string",
+      label: "Return ID",
+      description: "The ID of the return",
+      async options({ page }) {
+        const { items } = await this.listReturns({
+          params: {
+            limit: LIMIT,
+            offset: page * LIMIT,
+            stategroup: "all",
+          },
+        });
+        return items?.map(({
+          id, order_number: orderNumber,
+        }) => ({
+          label: `Return for Order Number: ${orderNumber}`,
+          value: id,
+        })) || [];
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return `${this.$auth.api_url}shops/${this.$auth.shop_id}`;
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: {
+          "everstox-shop-api-token": `${this.$auth.api_token}`,
+        },
+        ...opts,
+      });
+    },
+    getOrder({
+      orderId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/orders/${orderId}`,
+        ...opts,
+      });
+    },
+    getReturn({
+      returnId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/returns/v2/${returnId}`,
+        ...opts,
+      });
+    },
+    listOrders(opts = {}) {
+      return this._makeRequest({
+        path: "/orders",
+        ...opts,
+      });
+    },
+    listReturns(opts = {}) {
+      return this._makeRequest({
+        path: "/returns/v2",
+        ...opts,
+      });
+    },
+    listWarehouses(opts = {}) {
+      return this._makeRequest({
+        path: "/warehouses",
+        ...opts,
+      });
     },
   },
-};
+};

package/package.json

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