@pipedream/shopify_developer_app 0.6.4 → 0.7.0

package/actions/get-metafields/get-metafields.mjs

@@ -1,19 +1,51 @@
 import metafieldActions from "../common/metafield-actions.mjs";
-import common from "@pipedream/shopify/actions/get-metafields/common.mjs";
+import common from "@pipedream/shopify/actions/get-metafields/get-metafields.mjs";
+import shopify from "../../shopify_developer_app.app.mjs";
+
+const {
+  name, description, type,
+} = common;
 
 export default {
-  ...common,
   key: "shopify_developer_app-get-metafields",
-  name: "Get Metafields",
-  description: "Retrieves a list of metafields that belong to a resource. [See the docs](https://shopify.dev/api/admin-rest/2023-01/resources/metafield#get-metafields?metafield[owner-id]=382285388&metafield[owner-resource]=blog)",
-  version: "0.0.5",
-  type: "action",
+  version: "0.0.6",
+  name,
+  description,
+  type,
   props: {
+    shopify,
     ...metafieldActions.props,
-    ...common.props,
+    namespace: {
+      type: "string[]",
+      label: "Namespace",
+      description: "Filter results by namespace",
+      optional: true,
+    },
+    key: {
+      type: "string[]",
+      label: "Key",
+      description: "Filter results by key",
+      optional: true,
+    },
   },
   methods: {
     ...metafieldActions.methods,
-    ...common.methods,
+  },
+  async additionalProps() {
+    return this.getOwnerIdProp(this.ownerResource);
+  },
+  async run({ $ }) {
+    let response = await this.listMetafields(this.ownerResource, this.ownerId);
+
+    if (this.namespace?.length > 0) {
+      response = response.filter((field) => this.namespace.includes(field.namespace));
+    }
+
+    if (this.key?.length > 0) {
+      response = response.filter((field) => this.key.includes(field.key));
+    }
+
+    $.export("$summary", `Found ${response.length} metafield(s) for object with ID ${this.ownerId}`);
+    return response;
   },
 };

package/actions/get-metaobjects/get-metaobjects.mjs

@@ -1,26 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import metaobjects from "../common/metaobjects.mjs";
-import common from "@pipedream/shopify/actions/get-metaobjects/common.mjs";
+import common from "@pipedream/shopify/actions/get-metaobjects/get-metaobjects.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...metaobjects,
-  ...common,
+  ...others,
   key: "shopify_developer_app-get-metaobjects",
-  name: "Get Metaobjects",
-  description: "Retrieves a list of metaobjects. [See the documentation](https://shopify.dev/docs/api/admin-graphql/2023-04/queries/metaobjects)",
-  version: "0.0.5",
-  type: "action",
+  version: "0.0.6",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    type: {
-      type: "string",
-      label: "Type",
-      description: "The Metaobject Type",
-      async options() {
-        const { data: { metaobjectDefinitions: { nodes } } }
-          = await this.listMetaobjectDefinitions();
-        return nodes?.map(({ type }) => type) || [];
-      },
-    },
+    ...props,
   },
 };

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

@@ -1,23 +1,25 @@
-import app from "../../common/rest-admin.mjs";
+import shopify from "../../shopify_developer_app.app.mjs";
+import { MAX_LIMIT } from "@pipedream/shopify/common/constants.mjs";
 
 export default {
   key: "shopify_developer_app-get-order",
   name: "Get Order",
-  description: "Retrieve an order by specifying the order ID. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2024-10/resources/order#get-orders)",
-  version: "0.0.2",
+  description: "Retrieve an order by specifying the order ID. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/queries/order)",
+  version: "0.0.3",
   type: "action",
   props: {
-    app,
+    shopify,
     orderId: {
       propDefinition: [
-        app,
+        shopify,
         "orderId",
       ],
     },
   },
   async run({ $ }) {
-    const response = await this.app.getOrder({
-      orderId: this.orderId,
+    const response = await this.shopify.getOrder({
+      id: this.orderId,
+      first: MAX_LIMIT,
     });
     $.export("$summary", `Successfully retrieved order with ID: ${this.orderId}`);
     return response;

package/actions/get-pages/get-pages.mjs

@@ -1,14 +1,22 @@
-import app from "../../common/rest-admin.mjs";
-import common from "@pipedream/shopify/actions/get-pages/common.mjs";
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "@pipedream/shopify/actions/get-pages/get-pages.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-get-pages",
-  name: "Get Pages",
-  description: "Retrieve a list of all pages. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/page#get-pages)",
-  version: "0.0.6",
-  type: "action",
+  version: "0.0.7",
+  name,
+  description,
+  type,
   props: {
-    app,
+    shopify,
+    ...props,
   },
 };

package/actions/search-custom-collection-by-name/search-custom-collection-by-name.mjs

@@ -1,22 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/actions/search-custom-collection-by-name/common.mjs";
+import common from "@pipedream/shopify/actions/search-custom-collection-by-name/search-custom-collection-by-name.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-search-custom-collection-by-name",
-  name: "Search Custom Collection by Name",
-  description: "Search for a custom collection by name/title. [See the documentation](https://shopify.dev/docs/api/admin-rest/2023-01/resources/customcollection#get-custom-collections)",
-  version: "0.0.4",
-  type: "action",
+  version: "0.0.5",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    title: {
-      propDefinition: [
-        shopify,
-        "title",
-      ],
-      description: "The name of the custom collection",
-    },
-    ...common.props,
+    ...props,
   },
 };

package/actions/search-customers/search-customers.mjs

@@ -1,27 +1,37 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/actions/search-customers/common.mjs";
 
 export default {
-  ...common,
   key: "shopify_developer_app-search-customers",
   name: "Search for Customers",
-  description: "Search for a customer or a list of customers. [See the documentation](https://shopify.dev/api/admin-rest/2022-01/resources/customer#[get]/admin/api/2022-01/customers.json)",
-  version: "0.0.4",
+  description: "Search for a customer or a list of customers. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/queries/customers)",
+  version: "0.0.5",
   type: "action",
   props: {
     shopify,
     query: {
-      propDefinition: [
-        shopify,
-        "query",
-      ],
+      type: "string",
+      label: "Query",
+      description: "The search query",
     },
     max: {
-      propDefinition: [
-        shopify,
-        "max",
-      ],
+      type: "integer",
+      label: "Max Records",
+      description: "Optionally limit the maximum number of records to return. Leave blank to retrieve all records.",
+      optional: true,
     },
-    ...common.props,
+  },
+  async run({ $ }) {
+    const response = await this.shopify.getPaginated({
+      resourceFn: this.shopify.listCustomers,
+      resourceKeys: [
+        "customers",
+      ],
+      variables: {
+        query: this.query,
+      },
+      max: this.max,
+    });
+    $.export("$summary", `Found ${response.length} customer(s)`);
+    return response;
   },
 };

package/actions/search-product-variant/search-product-variant.mjs

@@ -1,38 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/actions/search-product-variant/common.mjs";
+import common from "@pipedream/shopify/actions/search-product-variant/search-product-variant.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-search-product-variant",
-  name: "Search for Product Variant",
-  description: "Search for product variants or create one if not found. [See the documentation](https://shopify.dev/api/admin-rest/2022-01/resources/product-variant#top)",
-  version: "0.0.4",
-  type: "action",
+  version: "0.0.5",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    productId: {
-      propDefinition: [
-        shopify,
-        "productId",
-      ],
-    },
-    productVariantId: {
-      propDefinition: [
-        shopify,
-        "productVariantId",
-        (c) => c,
-      ],
-      description: "ID of the product variant. Takes precedence over **Title**",
-      optional: true,
-    },
-    title: {
-      propDefinition: [
-        shopify,
-        "title",
-      ],
-      description: "The name of the product variant",
-      optional: true,
-    },
-    ...common.props,
+    ...props,
   },
 };

package/actions/search-products/search-products.mjs

@@ -1,48 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/actions/search-products/common.mjs";
+import common from "@pipedream/shopify/actions/search-products/search-products.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-search-products",
-  name: "Search for Products",
-  description: "Search for products. [See the documentation](https://shopify.dev/api/admin-rest/2022-01/resources/product#[get]/admin/api/2022-01/products.json)",
-  version: "0.0.4",
-  type: "action",
+  version: "0.0.5",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    title: {
-      propDefinition: [
-        shopify,
-        "title",
-      ],
-      optional: true,
-    },
-    productIds: {
-      propDefinition: [
-        shopify,
-        "productId",
-      ],
-      type: "string[]",
-      optional: true,
-    },
-    collectionId: {
-      propDefinition: [
-        shopify,
-        "collectionId",
-      ],
-    },
-    productType: {
-      propDefinition: [
-        shopify,
-        "productType",
-      ],
-    },
-    vendor: {
-      propDefinition: [
-        shopify,
-        "vendor",
-      ],
-    },
-    ...common.props,
+    ...props,
   },
 };

package/actions/update-article/update-article.mjs

@@ -1,43 +1,22 @@
-import app from "../../common/rest-admin.mjs";
-import common from "@pipedream/shopify/actions/update-article/common.mjs";
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "@pipedream/shopify/actions/update-article/update-article.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-update-article",
-  name: "Update Article",
-  description: "Update a blog article. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/article#put-blogs-blog-id-articles-article-id)",
-  version: "0.0.6",
-  type: "action",
+  version: "0.0.7",
+  name,
+  description,
+  type,
   props: {
-    app,
-    blogId: {
-      propDefinition: [
-        app,
-        "blogId",
-      ],
-    },
-    articleId: {
-      propDefinition: [
-        app,
-        "articleId",
-        ({ blogId }) => ({
-          blogId,
-        }),
-      ],
-    },
-    title: {
-      description: "The title of the article.",
-      propDefinition: [
-        app,
-        "title",
-      ],
-    },
-    bodyHtml: {
-      description: "The text content of the article, complete with HTML markup.",
-      propDefinition: [
-        app,
-        "bodyHtml",
-      ],
-    },
+    shopify,
+    ...props,
   },
 };

package/actions/update-customer/update-customer.mjs

@@ -1,14 +1,12 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import metafieldActions from "../common/metafield-actions.mjs";
-import common from "@pipedream/shopify/actions/update-customer/common.mjs";
+import common from "../common/metafield-actions.mjs";
 
 export default {
-  ...metafieldActions,
   ...common,
   key: "shopify_developer_app-update-customer",
   name: "Update Customer",
-  description: "Update a existing customer. [See the docs](https://shopify.dev/api/admin-rest/2022-01/resources/customer#[put]/admin/api/2022-01/customers/{customer_id}.json)",
-  version: "0.0.5",
+  description: "Update a existing customer. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerupdate)",
+  version: "0.0.6",
   type: "action",
   props: {
     shopify,
@@ -86,4 +84,30 @@ export default {
       ],
     },
   },
+  async run({ $ }) {
+    const metafields = await this.createMetafieldsArray(this.metafields, this.customerId, "customer");
+
+    const response = await this.shopify.updateCustomer({
+      input: {
+        id: this.customerId,
+        firstName: this.firstName,
+        lastName: this.lastName,
+        email: this.email,
+        phone: this.phone,
+        addresses: [
+          {
+            address1: this.address,
+            company: this.company,
+            city: this.city,
+            province: this.province,
+            country: this.country,
+            zip: this.zip,
+          },
+        ],
+        metafields,
+      },
+    });
+    $.export("$summary", `Updated customer \`${response.customerUpdate.customer.email || response.customerUpdate.customer.firstName}\` with ID \`${response.customerUpdate.customer.id}\``);
+    return response;
+  },
 };

package/actions/update-inventory-level/update-inventory-level.mjs

@@ -1,36 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/actions/update-inventory-level/common.mjs";
+import common from "@pipedream/shopify/actions/update-inventory-level/update-inventory-level.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-update-inventory-level",
-  name: "Update Inventory Level",
-  description: "Sets the inventory level for an inventory item at a location. [See the documenation](https://shopify.dev/api/admin-rest/2022-01/resources/inventorylevel#[post]/admin/api/2022-01/inventory_levels/set.json)",
-  version: "0.0.4",
-  type: "action",
+  version: "0.0.5",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    locationId: {
-      propDefinition: [
-        shopify,
-        "locationId",
-      ],
-    },
-    productId: {
-      propDefinition: [
-        shopify,
-        "productId",
-      ],
-    },
-    inventoryItemId: {
-      propDefinition: [
-        shopify,
-        "inventoryItemId",
-        (c) => ({
-          productId: c.productId,
-        }),
-      ],
-    },
-    ...common.props,
+    ...props,
   },
 };

package/actions/update-metafield/update-metafield.mjs

@@ -1,17 +1,21 @@
 import metafieldActions from "../common/metafield-actions.mjs";
-import common from "@pipedream/shopify/actions/update-metafield/common.mjs";
-import shopify from "@pipedream/shopify/shopify.app.mjs";
+import common from "@pipedream/shopify/actions/update-metafield/update-metafield.mjs";
+import shopify from "../../shopify_developer_app.app.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-update-metafield",
-  name: "Update Metafield",
-  description: "Updates a metafield belonging to a resource. [See the docs](https://shopify.dev/api/admin-rest/2023-01/resources/metafield#put-blogs-blog-id-metafields-metafield-id)",
-  version: "0.0.5",
-  type: "action",
+  version: "0.0.6",
+  name,
+  description,
+  type,
   props: {
+    shopify,
     ...metafieldActions.props,
-    ...common.props,
   },
   async additionalProps() {
     const props = await this.getOwnerIdProp(this.ownerResource);
@@ -31,15 +35,10 @@ export default {
   },
   methods: {
     ...metafieldActions.methods,
-    ...common.methods,
     async getOwnerIdProp(ownerResource) {
       const resources = {
         product: shopify.propDefinitions.productId,
         variants: shopify.propDefinitions.productVariantId,
-        product_image: {
-          ...shopify.propDefinitions.imageId,
-          optional: false,
-        },
         customer: shopify.propDefinitions.customerId,
         collection: {
           ...shopify.propDefinitions.collectionId,
@@ -49,12 +48,16 @@ export default {
         article: shopify.propDefinitions.articleId,
         page: shopify.propDefinitions.pageId,
         order: shopify.propDefinitions.orderId,
-        draft_order: shopify.propDefinitions.draftOrderId,
+        draftOrder: {
+          type: "string",
+          label: "Draft Order ID",
+          description: "The identifier of a draft order",
+        },
       };
 
       const props = {};
 
-      if (ownerResource === "variants" || ownerResource === "product_image") {
+      if (ownerResource === "variants") {
         props.productId = resources.product;
       }
       if (ownerResource === "article") {

package/actions/update-metaobject/update-metaobject.mjs

@@ -1,32 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import metaobjects from "../common/metaobjects.mjs";
-import common from "@pipedream/shopify/actions/update-metaobject/common.mjs";
+import common from "@pipedream/shopify/actions/update-metaobject/update-metaobject.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...metaobjects,
-  ...common,
+  ...others,
   key: "shopify_developer_app-update-metaobject",
-  name: "Update Metaobject",
-  description: "Updates a metaobject. [See the documentation](https://shopify.dev/docs/api/admin-graphql/2023-04/mutations/metaobjectUpdate)",
-  version: "0.0.7",
-  type: "action",
-  methods: {
-    ...metaobjects.methods,
-    ...common.methods,
-  },
+  version: "0.0.8",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    type: {
-      type: "string",
-      label: "Type",
-      description: "The Metaobject Type",
-      async options() {
-        const { data: { metaobjectDefinitions: { nodes } } }
-          = await this.listMetaobjectDefinitions();
-        return nodes?.map(({ type }) => type) || [];
-      },
-      reloadProps: true,
-    },
-    ...common.props,
+    ...props,
   },
 };