Add File Sharing Preference with Google Drive API on New Invoice Created from Square API

Pipedream makes it easy to connect APIs for Google Drive, Square and 2,000+ other apps remarkably fast.

Trigger workflow on

New Invoice Created from the Square API

Next, do this

Add File Sharing Preference with the Google Drive API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Square trigger and Google Drive action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Invoice Created trigger
1. Connect your Square account
2. Configure timer
3. Select a Location
Configure the Add File Sharing Preference action
1. Connect your Google Drive account
2. Optional- Select a Drive
3. Select a File or Folder
4. Optional- Select a Role
5. Optional- Select a Type
6. Optional- Configure Domain
7. Optional- Configure Email Address
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Invoice Created on Square

Description:Emit new event for every new invoice created. [See the docs](https://developer.squareup.com/reference/square/invoices-api/search-invoices)

Version:0.0.3

Key:square-new-invoice-created

View on GitHub

Square Overview#

The Square API opens up a realm of possibilities for merchants to effortlessly manage their sales, inventory, customers, and payments. With Pipedream, you can automate actions based on events in Square, such as new transactions, updated orders, or customer profile changes. Craft custom workflows that react in real-time, sync data across platforms, or streamline reporting. Through Pipedream's serverless platform, you can connect Square with countless other apps without writing extensive code, turning manual tasks into automated, efficient processes.

Trigger Code#

import base from "../common/base-polling.mjs";
import constants from "../common/constants.mjs";

export default {
  ...base,
  key: "square-new-invoice-created",
  name: "New Invoice Created",
  description: "Emit new event for every new invoice created. [See the docs](https://developer.squareup.com/reference/square/invoices-api/search-invoices)",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    ...base.props,
    location: {
      propDefinition: [
        base.props.square,
        "location",
      ],
    },
  },
  hooks: {
    ...base.hooks,
    async deploy() {
      console.log(`Retrieving at most last ${constants.MAX_HISTORICAL_EVENTS} objects...`);
      const { invoices } = await this.square.searchInvoices({
        data: {
          ...this.getBaseParams(),
        },
      });
      if (!(invoices?.length > 0)) {
        return;
      }
      this._setLastTs(Date.parse(invoices[0].created_at));
      invoices?.slice(0, constants.MAX_HISTORICAL_EVENTS)
        .reverse()
        .forEach((invoice) => this.$emit(invoice, this.generateMeta(invoice)));
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        limit: constants.MAX_LIMIT,
        query: {
          sort: {
            field: "INVOICE_SORT_DATE",
            order: "DESC",
          },
          filter: {
            location_ids: [
              this.location,
            ],
          },
        },
      };
    },
    generateMeta(invoice) {
      return {
        id: invoice.id,
        summary: `Invoice created: ${invoice.id}`,
        ts: Date.parse(invoice.created_at),
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let newLastTs;
    let cursor;
    let done = false;

    do {
      const response = await this.square.searchInvoices({
        data: {
          ...this.getBaseParams(),
          cursor,
        },
      });
      const { invoices } = response;
      if (!(invoices?.length > 0)) {
        break;
      }
      if (!newLastTs) {
        newLastTs = Date.parse(invoices[0].created_at);
      }
      for (const invoice of invoices) {
        if (Date.parse(invoice.created_at) <= lastTs) {
          done = true;
          break;
        }
        this.emitEvent(invoice);
      }
      cursor = response?.cursor;
    } while (cursor && !done);

    this._setLastTs(newLastTs);
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Square	`square`	`app`	This component uses the Square app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Location	`location`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Square uses OAuth authentication. When you connect your Square account, Pipedream will open a popup window where you can sign into Square and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Square API.

Pipedream requests the following authorization scopes when you connect your account:

CUSTOMERS_READCUSTOMERS_WRITEPAYMENTS_READPAYMENTS_WRITEORDERS_READORDERS_WRITESUBSCRIPTIONS_READSUBSCRIPTIONS_WRITEITEMS_READITEMS_WRITEINVOICES_READINVOICES_WRITELOYALTY_READLOYALTY_WRITEEMPLOYEES_READEMPLOYEES_WRITEMERCHANT_PROFILE_READBANK_ACCOUNTS_READSETTLEMENTS_READDEVELOPER_APPLICATION_WEBHOOKS_WRITEAPPOINTMENTS_ALL_READAPPOINTMENTS_READ

About Square#

Solutions & Tools to Grow Your Business

Action#

Add File Sharing Preference on Google Drive

Description:Add a [sharing](https://support.google.com/drive/answer/7166529) permission to the sharing preferences of a file or folder and provide a sharing URL. [See the docs](https://developers.google.com/drive/api/v3/reference/permissions/create) for more information

Version:0.1.4

Key:google_drive-add-file-sharing-preference

View on GitHub

Google Drive Overview#

The Google Drive API on Pipedream allows you to automate various file management tasks, such as creating, reading, updating, and deleting files within your Google Drive. You can also share files, manage permissions, and monitor changes to files and folders. This opens up possibilities for creating workflows that seamlessly integrate with other apps and services, streamlining document handling, backup processes, and collaborative workflows.

Action Code#

import googleDrive from "../../google_drive.app.mjs";

/**
 * Uses Google Drive API to create a permission for a file. The role granted by
 * the permission is one of `owner`,`organizer`,`fileOrganizer`,
 * `writer`,`commenter`, `reader`. See the [Google Drive API Reference for
 * Permissions](https://bit.ly/2XKKG1X) for more information.
 */
export default {
  key: "google_drive-add-file-sharing-preference",
  name: "Add File Sharing Preference",
  description:
    "Add a [sharing](https://support.google.com/drive/answer/7166529) permission to the sharing preferences of a file or folder and provide a sharing URL. [See the docs](https://developers.google.com/drive/api/v3/reference/permissions/create) for more information",
  version: "0.1.4",
  type: "action",
  props: {
    googleDrive,
    drive: {
      propDefinition: [
        googleDrive,
        "watchedDrive",
      ],
      optional: true,
    },
    fileOrFolderId: {
      propDefinition: [
        googleDrive,
        "fileOrFolderId",
        (c) => ({
          drive: c.drive,
        }),
      ],
      optional: false,
      description: "The file or folder to share",
    },
    role: {
      propDefinition: [
        googleDrive,
        "role",
      ],
    },
    type: {
      propDefinition: [
        googleDrive,
        "type",
      ],
    },
    domain: {
      propDefinition: [
        googleDrive,
        "domain",
      ],
    },
    emailAddress: {
      propDefinition: [
        googleDrive,
        "emailAddress",
      ],
    },
  },
  async run({ $ }) {
    const {
      fileOrFolderId,
      role,
      type,
      domain,
      emailAddress,
    } = this;
    // Create the permission for the file
    await this.googleDrive.createPermission(fileOrFolderId, {
      role,
      type,
      domain,
      emailAddress,
    });

    // Get the file to get the `webViewLink` sharing URL
    const resp = await this.googleDrive.getFile(this.fileOrFolderId);
    const webViewLink = resp.webViewLink;
    $.export("$summary", `Successfully added a sharing permission to the file, "${resp.name}"`);
    return webViewLink;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Google Drive	`googleDrive`	`app`	This component uses the Google Drive app.
Drive	`drive`	`string`	Select a value from the drop down menu.
File or Folder	`fileOrFolderId`	`string`	Select a value from the drop down menu.
Role	`role`	`string`	Select a value from the drop down menu:`ownerorganizerfileOrganizerwritercommenterreader`
Type	`type`	`string`	Select a value from the drop down menu:`usergroupdomainanyone`
Domain	`domain`	`string`	The domain of the G Suite organization to which this permission refers if Type is `domain` (e.g., `yourcomapany.com`)
Email Address	`emailAddress`	`string`	The email address of the user or group to which this permission refers if Type is `user` or `group`

Action Authentication#

Google Drive uses OAuth authentication. When you connect your Google Drive account, Pipedream will open a popup window where you can sign into Google Drive and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Drive API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/drivehttps://www.googleapis.com/auth/drive.readonly

About Google Drive#

Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.

More Ways to Connect Google Drive + Square#

Other Popular Integrations#

Create Customer with Square API on Changes to Specific Files (Shared Drive) from Google Drive API

Google Drive + Square

Add File Sharing Preference with Google Drive API on New Invoice Created from Square API

Pipedream makes it easy to connect APIs for Google Drive, Square and 2,000+ other apps remarkably fast.

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular