Add File to Project with Crowdin API on New Invoice Created from Square API

Pipedream makes it easy to connect APIs for Crowdin, Square and 2,500+ other apps remarkably fast.

Trigger workflow on

New Invoice Created from the Square API

Next, do this

Add File to Project with the Crowdin API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Square trigger and Crowdin 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 to Project action
1. Connect your Crowdin account
2. Select a Project ID
3. Configure File
4. Configure Name
5. Optional- Select a Branch ID
6. Optional- Select a Directory ID
7. Optional- Configure Title
8. Optional- Configure Context
9. Optional- Select a File Type
10. Optional- Configure Parser Version
11. Optional- Select one or more Attach Label IDs
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 to Project on Crowdin

Description:Adds a file into the created project. [See the documentation](https://developer.crowdin.com/api/v2/#tag/source-files/operation/api.projects.files.post)

Version:0.0.1

Key:crowdin-add-file

View on GitHub

Crowdin Overview#

The Crowdin API offers a way to streamline localization processes by enabling automated interactions with Crowdin projects. With this API on Pipedream, you can create workflows that manage translations, coordinate with translators, and sync localized content across your apps. It becomes easy to upload new source files, download translations, manage projects, and crowdsource translations, all within the Pipedream ecosystem.

Action Code#

import fs from "fs";
import { TYPE_OPTIONS } from "../../common/constants.mjs";
import {
  checkTmp,
  parseObject,
} from "../../common/utils.mjs";
import crowdin from "../../crowdin.app.mjs";

export default {
  key: "crowdin-add-file",
  name: "Add File to Project",
  description: "Adds a file into the created project. [See the documentation](https://developer.crowdin.com/api/v2/#tag/source-files/operation/api.projects.files.post)",
  version: "0.0.1",
  type: "action",
  props: {
    crowdin,
    projectId: {
      propDefinition: [
        crowdin,
        "projectId",
      ],
    },
    file: {
      type: "string",
      label: "File",
      description: "The path to the file saved to the `/tmp` directory  (e.g. `/tmp/example.jpg`) to process. [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory).",
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the file in Crowdin. **Note:** Can't contain `\\ / : * ? \" < > |` symbols. `ZIP` files are not allowed.",
    },
    branchId: {
      propDefinition: [
        crowdin,
        "branchId",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
    },
    directoryId: {
      propDefinition: [
        crowdin,
        "directoryId",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
    },
    title: {
      type: "string",
      label: "Title",
      description: "Use to provide more details for translators. Title is available in UI only",
      optional: true,
    },
    context: {
      type: "string",
      label: "Context",
      description: "Use to provide context about whole file",
      optional: true,
    },
    type: {
      type: "string",
      label: "File Type",
      description: "The type of the file. **Note:** Use `docx` type to import each cell as a separate source string for XLSX file. Default is `auto`",
      options: TYPE_OPTIONS,
      optional: true,
    },
    parserVersion: {
      type: "integer",
      label: "Parser Version",
      description: "Using latest parser version by default. **Note:** Must be used together with `type`.",
      optional: true,
    },
    attachLabelIds: {
      propDefinition: [
        crowdin,
        "attachLabelIds",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
    },
  },
  async run({ $ }) {
    const {
      crowdin,
      attachLabelIds,
      projectId,
      file,
      ...data
    } = this;

    const fileBinary = fs.readFileSync(checkTmp(file));
    const crowdinFilename = file.startsWith("/tmp/")
      ? file.slice(5)
      : file;

    const fileResponse = await crowdin.createStorage({
      data: Buffer.from(fileBinary, "binary"),
      headers: {
        "Crowdin-API-FileName": encodeURI(crowdinFilename),
        "Content-Type": "application/octet-stream",
      },
    });

    const response = await crowdin.uploadFileToProject({
      $,
      projectId,
      data: {
        ...data,
        storageId: fileResponse.data.id,
        attachLabelIds: parseObject(attachLabelIds),
      },
    });
    $.export("$summary", `Successfully uploaded file: ${this.name}`);
    return response;
  },
};

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
Crowdin	`crowdin`	`app`	This component uses the Crowdin app.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
File	`file`	`string`	The path to the file saved to the `/tmp` directory (e.g. `/tmp/example.jpg`) to process. See the documentation
Name	`name`	`string`	The name of the file in Crowdin. Note: Can't contain `\ / : * ? " < > \|` symbols. `ZIP` files are not allowed.
Branch ID	`branchId`	`string`	Select a value from the drop down menu.
Directory ID	`directoryId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	Use to provide more details for translators. Title is available in UI only
Context	`context`	`string`	Use to provide context about whole file
File Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Try to detect file type by extension or MIME type", "value": "auto" }{ "label": "Android (.xml)", "value": "android" }{ "label": "Mac OS X / iOS (.strings)", "value": "macosx" }{ "label": ".NET, Windows Phone (.resx)", "value": "resx" }{ "label": "Java (.properties)", "value": "properties" }{ "label": "GNU GetText (.po, .pot)", "value": "gettext" }{ "label": "Ruby On Rails (.yaml, .yml)", "value": "yaml" }{ "label": "Hypertext Preprocessor (.php)", "value": "php" }{ "label": "Generic JSON (.json)", "value": "json" }{ "label": "Generic XML (.xml)", "value": "xml" }{ "label": "Generic INI (.ini)", "value": "ini" }{ "label": "Windows Resources (.rc)", "value": "rc" }{ "label": "Windows 8 Metro (.resw)", "value": "resw" }{ "label": "Windows 8 Metro (.resjson)", "value": "resjson" }{ "label": "Nokia Qt (.ts)", "value": "qtts" }{ "label": "Joomla localizable resources (.ini)", "value": "joomla" }{ "label": "Google Chrome Extension (.json)", "value": "chrome" }{ "label": "Mozilla DTD (.dtd)", "value": "dtd" }{ "label": "Delphi DKLang (.dklang)", "value": "dklang" }{ "label": "Flex (.properties)", "value": "flex" }{ "label": "NSIS Installer Resources (.nsh)", "value": "nsh" }{ "label": "WiX Installer (.wxl)", "value": "wxl" }{ "label": "XLIFF (.xliff, .xlf)", "value": "xliff" }{ "label": "XLIFF 2.0 (.xliff, .xlf)", "value": "xliff_two" }{ "label": "HTML (.html, .htm, .xhtml, .xhtm, .xht, .hbs, .liquid)", "value": "html" }{ "label": "Haml (.haml)", "value": "haml" }{ "label": "Plain Text (.txt)", "value": "txt" }{ "label": "Comma Separated Values (.csv)", "value": "csv" }{ "label": "Markdown (.md, .text, .markdown...)", "value": "md" }{ "label": "MadCap Flare (.flnsp, .flpgpl .fltoc)", "value": "flsnp" }{ "label": "Jekyll HTML (.html)", "value": "fm_html" }{ "label": "Jekyll Markdown (.md)", "value": "fm_md" }{ "label": "MediaWiki (.wiki, .wikitext, .mediawiki)", "value": "mediawiki" }{ "label": "Microsoft Office, OpenOffice.org Documents, Adobe InDesign, Adobe FrameMaker(.docx, .dotx, .docm, .dotm, .xlsx, .xltx, .xlsm, .xltm, .pptx, .potx, .ppsx, .pptm, .potm, .ppsm, .odt, .ods, .odg, .odp, .imdl, .mif)", "value": "docx" }{ "label": "Microsoft Excel (.xlsx)", "value": "xlsx" }{ "label": "Youtube .sbv (.sbv)", "value": "sbv" }{ "label": "Play Framework", "value": "properties_play" }{ "label": "Java Application (.xml)", "value": "properties_xml" }{ "label": "Maxthon Browser (.ini)", "value": "maxthon" }{ "label": "Go (.gotext.json)", "value": "go_json" }{ "label": "DITA Document (.dita, .ditamap)", "value": "dita" }{ "label": "Adobe FrameMaker (.mif)", "value": "mif" }{ "label": "Adobe InDesign (.idml)", "value": "idml" }{ "label": "iOS (.stringsdict)", "value": "stringsdict" }{ "label": "Mac OS property list (.plist)", "value": "plist" }{ "label": "Video Subtitling and WebVTT (.vtt)", "value": "vtt" }{ "label": "Steamworks Localization Valve Data File (.vdf)", "value": "vdf" }{ "label": "SubRip .srt (.srt)", "value": "srt" }{ "label": "Salesforce (.stf)", "value": "stf" }{ "label": "Toml (.toml)", "value": "toml" }{ "label": "Contentful (.json)", "value": "contentful_rt" }{ "label": "SVG (.svg)", "value": "svg" }{ "label": "JavaScript (.js)", "value": "js" }{ "label": "CoffeeScript (.coffee)", "value": "coffee" }{ "label": "NestJS i18n", "value": "nestjs_i18n" }`
Parser Version	`parserVersion`	`integer`	Using latest parser version by default. Note: Must be used together with `type`.
Attach Label IDs	`attachLabelIds`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

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

notificationprojectmtwebhookai

About Crowdin#

Agile localization for tech companies. Crowdin is a cloud-based solution that streamlines localization management for your team. It's the perfect place to effectively manage all of your multilingual content.

More Ways to Connect Crowdin + Square#

Other Popular Integrations#

Add File to Project with Crowdin API on Catalog Item Updated from Square API

Square + Crowdin

Add File to Project with Crowdin API on New Invoice Created from Square API

Pipedream makes it easy to connect APIs for Crowdin, Square and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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