@pipedream/shopify_developer_app 0.0.1 → 0.1.1

package/README.md

@@ -0,0 +1,31 @@
+# Overview
+By creating a custom app on Shopify, you will be able to configure the exact scopes that you require to build the workflows that you need.
+
+# Getting Started
+
+To get started, you will need to create a custom Shopify app in the Shopify Admin UI. The steps are outlined below:
+
+## Create a Shopify app
+1. Sign in to your Shopify admin account, and navigate to the store that you are managing. 
+2. Click **Develop apps**.
+3. Click **Allow custom app development**.
+4. Click **Create an App**, and name the app "Pipedream"
+
+  ![Create an App](https://res.cloudinary.com/dpenc2lit/image/upload/v1688060015/Screenshot_2023-06-29_at_10.11.43_AM_unkom4.png)
+
+## Configure Admin API scopes
+1. In the new app you have created, under the **Configuration** tab, click **Configure Admin API scopes**
+2. Select the scopes that you require for your use case. You may modify your scopes at any time by returning to the app configuration page.
+
+## Generate the Admin API access token
+1. Under API credentials, click **Install app**.
+2. Click **Reveal token once** and save it in a secure location (we recommend using a password manager such as 1Password) -- you will need it when setting up authentication on Pipedream, and it is only revealed once. If you happen to lose this, you will need to uninstall the app, and reinstall it on Shopify to generate a new access token.
+
+  ![API Credentials](https://res.cloudinary.com/dpenc2lit/image/upload/v1688061470/Screenshot_2023-06-29_at_10.54.53_AM_jta5gc.png)
+
+## Connect your Shopify app with Pipedream using your access token
+
+At this point, you should have a Pipedream App connected to your Shopify store, and a long-lived access token.
+
+1. When prompted in Pipedream after trying to connect the Shopify Developer App, copy and paste your **shop id** along with your **access token** saved from the previous step.
+2. Click **Connect** and your custom Shopify app should be integrated into Pipedream!

package/actions/add-product-to-custom-collection/add-product-to-custom-collection.mjs

@@ -0,0 +1,32 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "../../../shopify/actions/add-product-to-custom-collection/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-add-product-to-custom-collection",
+  name: "Add Products to Custom Collections",
+  description: "Adds a product or products to a custom collection or collections. [See the docs](https://shopify.dev/docs/api/admin-rest/2023-01/resources/collect#post-collects)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shopify,
+    productIds: {
+      propDefinition: [
+        shopify,
+        "productId",
+      ],
+      type: "string[]",
+      label: "Product IDs",
+    },
+    collectionIds: {
+      propDefinition: [
+        shopify,
+        "collectionId",
+      ],
+      type: "string[]",
+      label: "Collection IDs",
+      description: "IDs of the collections that the product will be added to",
+      optional: false,
+    },
+  },
+};

package/actions/add-tags/add-tags.mjs

@@ -0,0 +1,15 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "../../../shopify/actions/add-tags/common.mjs";
+
+export default {
+  ...common,
+  name: "Add Tags",
+  version: "0.0.1",
+  key: "shopify_developer_app-add-tags",
+  description: "Add tags. [See the documentation](https://shopify.dev/api/admin-graphql/2022-07/mutations/tagsadd)",
+  type: "action",
+  props: {
+    shopify,
+    ...common.props,
+  },
+};

package/actions/common/metafield-actions.mjs

@@ -0,0 +1,10 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import metafieldActions from "../../../shopify/actions/common/metafield-actions.mjs";
+
+export default {
+  ...metafieldActions,
+  props: {
+    ...metafieldActions.props,
+    shopify,
+  },
+};

package/actions/common/metaobjects.mjs

@@ -0,0 +1,21 @@
+import metaobjects from "../../../shopify/actions/common/metaobjects.mjs";
+import { axios } from "@pipedream/platform";
+
+export default {
+  ...metaobjects,
+  methods: {
+    ...metaobjects.methods,
+    async makeGraphQLRequest({
+      $ = this, ...args
+    }) {
+      return axios($, {
+        url: `https://${this.shopify.getShopId()}.myshopify.com/admin/api/2023-04/graphql.json`,
+        method: "POST",
+        headers: {
+          "X-Shopify-Access-Token": `${this.shopify.$auth.access_token}`,
+        },
+        ...args,
+      });
+    },
+  },
+};

package/actions/create-article/create-article.mjs

@@ -0,0 +1,34 @@
+import app from "../../common/rest-admin.mjs";
+import common from "../../../shopify/actions/create-article/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-article",
+  name: "Create Article",
+  description: "Create a new blog article. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/article#post-blogs-blog-id-articles)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    blogId: {
+      propDefinition: [
+        app,
+        "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",
+      ],
+    },
+  },
+};

package/actions/create-blog/create-blog.mjs

@@ -0,0 +1,21 @@
+import app from "../../common/rest-admin.mjs";
+import common from "../../../shopify/actions/create-blog/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-blog",
+  name: "Create Blog",
+  description: "Create a new blog. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/blog#post-blogs)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    title: {
+      description: "The title of the blog.",
+      propDefinition: [
+        app,
+        "title",
+      ],
+    },
+  },
+};

package/actions/create-custom-collection/create-custom-collection.mjs

@@ -0,0 +1,36 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "../../../shopify/actions/create-custom-collection/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-custom-collection",
+  name: "Create Custom Collection",
+  description: "Create a new custom collection. [See the documentation](https://shopify.dev/docs/api/admin-rest/2023-01/resources/customcollection#post-custom-collections)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shopify,
+    title: {
+      propDefinition: [
+        shopify,
+        "title",
+      ],
+      description: "The name of the custom collection",
+    },
+    products: {
+      propDefinition: [
+        shopify,
+        "productId",
+      ],
+      type: "string[]",
+      optional: true,
+    },
+    metafields: {
+      propDefinition: [
+        shopify,
+        "metafields",
+      ],
+    },
+    ...common.props,
+  },
+};

package/actions/create-customer/create-customer.mjs

@@ -0,0 +1,75 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "../../../shopify/actions/create-customer/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-customer",
+  name: "Create Customer",
+  description: "Create a new customer. [See the documentation](https://shopify.dev/api/admin-rest/2022-01/resources/customer#[post]/admin/api/2022-01/customers.json)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shopify,
+    firstName: {
+      propDefinition: [
+        shopify,
+        "firstName",
+      ],
+    },
+    lastName: {
+      propDefinition: [
+        shopify,
+        "lastName",
+      ],
+    },
+    email: {
+      propDefinition: [
+        shopify,
+        "email",
+      ],
+    },
+    phone: {
+      propDefinition: [
+        shopify,
+        "phone",
+      ],
+    },
+    address: {
+      propDefinition: [
+        shopify,
+        "address",
+      ],
+    },
+    company: {
+      propDefinition: [
+        shopify,
+        "company",
+      ],
+    },
+    city: {
+      propDefinition: [
+        shopify,
+        "city",
+      ],
+    },
+    province: {
+      propDefinition: [
+        shopify,
+        "province",
+      ],
+    },
+    country: {
+      propDefinition: [
+        shopify,
+        "country",
+      ],
+    },
+    zip: {
+      propDefinition: [
+        shopify,
+        "zip",
+      ],
+    },
+    ...common.props,
+  },
+};

package/actions/create-metafield/create-metafield.mjs

@@ -0,0 +1,19 @@
+import metafieldActions from "../common/metafield-actions.mjs";
+import common from "../../../shopify/actions/create-metafield/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-metafield",
+  name: "Create Metafield",
+  description: "Creates a metafield belonging to a resource. [See the docs](https://shopify.dev/api/admin-rest/2023-01/resources/metafield#post-blogs-blog-id-metafields)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...metafieldActions.props,
+    ...common.props,
+  },
+  methods: {
+    ...metafieldActions.methods,
+    ...common.methods,
+  },
+};

package/actions/create-metaobject/create-metaobject.mjs

@@ -0,0 +1,27 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import metaobjects from "../common/metaobjects.mjs";
+import common from "../../../shopify/actions/create-metaobject/common.mjs";
+
+export default {
+  ...metaobjects,
+  ...common,
+  key: "shopify_developer_app-create-metaobject",
+  name: "Create Metaobject",
+  description: "Creates a metaobject. [See the documentation](https://shopify.dev/docs/api/admin-graphql/2023-04/mutations/metaobjectCreate)",
+  version: "0.0.1",
+  type: "action",
+  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,
+    },
+  },
+};

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

@@ -0,0 +1,26 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "../../../shopify/actions/create-order/common.mjs";
+import { toSingleLineString } from "../../../shopify/actions/common/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-order",
+  name: "Create Order",
+  description: toSingleLineString(`Creates a new order.
+    For full order object details [see the docs](https://shopify.dev/api/admin-rest/2022-01/resources/order#[post]/admin/api/2022-01/orders.json)
+    or [see examples](https://shopify.dev/api/admin-rest/2022-01/resources/order#[post]/admin/api/#{api_version}/orders.json_examples)
+  `),
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shopify,
+    customerId: {
+      propDefinition: [
+        shopify,
+        "customerId",
+      ],
+      optional: true,
+    },
+    ...common.props,
+  },
+};

package/actions/create-page/create-page.mjs

@@ -0,0 +1,27 @@
+import app from "../../common/rest-admin.mjs";
+import common from "../../../shopify/actions/create-page/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-page",
+  name: "Create Page",
+  description: "Create a new page. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/page#post-pages)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    title: {
+      description: "The title of the page.",
+      propDefinition: [
+        app,
+        "title",
+      ],
+    },
+    bodyHtml: {
+      propDefinition: [
+        app,
+        "bodyHtml",
+      ],
+    },
+  },
+};

package/actions/create-product/create-product.mjs

@@ -0,0 +1,69 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "../../../shopify/actions/create-product/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-product",
+  name: "Create Product",
+  description: "Create a new product. [See the documentation](https://shopify.dev/api/admin-rest/2022-01/resources/product#[post]/admin/api/2022-01/products.json)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shopify,
+    title: {
+      propDefinition: [
+        shopify,
+        "title",
+      ],
+    },
+    productDescription: {
+      propDefinition: [
+        shopify,
+        "productDescription",
+      ],
+    },
+    vendor: {
+      propDefinition: [
+        shopify,
+        "vendor",
+      ],
+    },
+    productType: {
+      propDefinition: [
+        shopify,
+        "productType",
+      ],
+    },
+    status: {
+      propDefinition: [
+        shopify,
+        "status",
+      ],
+    },
+    images: {
+      propDefinition: [
+        shopify,
+        "images",
+      ],
+    },
+    options: {
+      propDefinition: [
+        shopify,
+        "options",
+      ],
+    },
+    variants: {
+      propDefinition: [
+        shopify,
+        "variants",
+      ],
+    },
+    tags: {
+      propDefinition: [
+        shopify,
+        "tags",
+      ],
+    },
+    ...common.props,
+  },
+};

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

@@ -0,0 +1,49 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "../../../shopify/actions/create-product-variant/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-product-variant",
+  name: "Create Product Variant",
+  description: "Create a new product variant. [See the documentation](https://shopify.dev/api/admin-rest/2022-01/resources/product-variant#[post]/admin/api/2022-01/products/{product_id}/variants.json)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shopify,
+    productId: {
+      propDefinition: [
+        shopify,
+        "productId",
+      ],
+    },
+    option: {
+      propDefinition: [
+        shopify,
+        "option",
+      ],
+    },
+    price: {
+      propDefinition: [
+        shopify,
+        "price",
+      ],
+      description: "The price of the product variant",
+    },
+    imageId: {
+      propDefinition: [
+        shopify,
+        "imageId",
+        (c) => ({
+          productId: c.productId,
+        }),
+      ],
+    },
+    sku: {
+      propDefinition: [
+        shopify,
+        "sku",
+      ],
+    },
+    ...common.props,
+  },
+};

package/actions/create-smart-collection/create-smart-collection.mjs

@@ -0,0 +1,27 @@
+import shopify from "../../shopify_developer_app.app.mjs";
+import { toSingleLineString } from "../../../shopify/actions/common/common.mjs";
+import common from "../../../shopify/actions/create-smart-collection/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-create-smart-collection",
+  name: "Create Smart Collection",
+  description: toSingleLineString(`
+    Creates a smart collection.
+    You can fill in any number of rules by selecting more than one option in each prop.
+    [See documentation](https://shopify.dev/api/admin-rest/2021-10/resources/smartcollection#post-smart-collections)
+  `),
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shopify,
+    title: {
+      propDefinition: [
+        shopify,
+        "title",
+      ],
+      description: "Title of the smart collection",
+    },
+    ...common.props,
+  },
+};

package/actions/delete-article/delete-article.mjs

@@ -0,0 +1,29 @@
+import app from "../../common/rest-admin.mjs";
+import common from "../../../shopify/actions/delete-article/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-delete-article",
+  name: "Delete Article",
+  description: "Delete an existing blog article. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/article#delete-blogs-blog-id-articles-article-id)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    blogId: {
+      propDefinition: [
+        app,
+        "blogId",
+      ],
+    },
+    articleId: {
+      propDefinition: [
+        app,
+        "articleId",
+        ({ blogId }) => ({
+          blogId,
+        }),
+      ],
+    },
+  },
+};

package/actions/delete-blog/delete-blog.mjs

@@ -0,0 +1,20 @@
+import app from "../../common/rest-admin.mjs";
+import common from "../../../shopify/actions/delete-blog/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-delete-blog",
+  name: "Delete Blog",
+  description: "Delete an existing blog. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/blog#delete-blogs-blog-id)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    blogId: {
+      propDefinition: [
+        app,
+        "blogId",
+      ],
+    },
+  },
+};

package/actions/delete-metafield/delete-metafield.mjs

@@ -0,0 +1,19 @@
+import metafieldActions from "../common/metafield-actions.mjs";
+import common from "../../../shopify/actions/delete-metafield/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-delete-metafield",
+  name: "Delete Metafield",
+  description: "Deletes a metafield belonging to a resource. [See the documentation](https://shopify.dev/docs/api/admin-rest/2023-01/resources/metafield#delete-blogs-blog-id-metafields-metafield-id)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...metafieldActions.props,
+    ...common.props,
+  },
+  methods: {
+    ...metafieldActions.methods,
+    ...common.methods,
+  },
+};

package/actions/delete-page/delete-page.mjs

@@ -0,0 +1,20 @@
+import app from "../../common/rest-admin.mjs";
+import common from "../../../shopify/actions/delete-page/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-delete-page",
+  name: "Delete Page",
+  description: "Delete an existing page. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/page#delete-pages-page-id)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    pageId: {
+      propDefinition: [
+        app,
+        "pageId",
+      ],
+    },
+  },
+};

package/actions/get-articles/get-articles.mjs

@@ -0,0 +1,20 @@
+import app from "../../common/rest-admin.mjs";
+import common from "../../../shopify/actions/get-articles/common.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-get-articles",
+  name: "Get Articles",
+  description: "Retrieve a list of all articles from a blog. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/article#get-blogs-blog-id-articles)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    blogId: {
+      propDefinition: [
+        app,
+        "blogId",
+      ],
+    },
+  },
+};

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

@@ -0,0 +1,19 @@
+import metafieldActions from "../common/metafield-actions.mjs";
+import common from "../../../shopify/actions/get-metafields/common.mjs";
+
+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.1",
+  type: "action",
+  props: {
+    ...metafieldActions.props,
+    ...common.props,
+  },
+  methods: {
+    ...metafieldActions.methods,
+    ...common.methods,
+  },
+};