Service Integrations Reference

https://parlel.com/docs/
Admin
This project provides comprehensive reference documentation for various service integrations,...
Tokens:654,862
Snippets:5,195
Trust Score:4.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start the Zoom Server

Source: https://parlel.com/docs/zoom.md

Quick start example to initialize and start the ZoomServer. Ensure to stop the server when done.

```javascript
import { ZoomServer } from "./services/zoom/src/server.js";

const server = new ZoomServer(4797);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start Mastodon Server

Source: https://parlel.com/docs/mastodon.md

Quick start example to initialize and start the Mastodon server. Ensure to stop the server after use.

```javascript
import { MastodonServer } from "./services/mastodon/src/server.js";

const server = new MastodonServer(4806);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start Okta Server

Source: https://parlel.com/docs/okta.md

Quick start example to initialize and start the Okta server. Ensure to stop the server after use.

```javascript
import { OktaServer } from "./services/okta/src/server.js";

const server = new OktaServer(4819);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Jenkins Server

Source: https://parlel.com/docs/jenkins.md

Quick start example demonstrating how to initialize, start, and stop the Jenkins server in memory.

```javascript
import { JenkinsServer } from "./services/jenkins/src/server.js";

const server = new JenkinsServer(4877);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Confluence Server

Source: https://parlel.com/docs/confluence.md

Quick start example demonstrating how to initialize, start, and stop the ConfluenceServer.

```javascript
import { ConfluenceServer } from "./services/confluence/src/server.js";

const server = new ConfluenceServer(4795);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start Sanity Emulator

Source: https://parlel.com/docs/sanity.md

Quick start example to initialize and start the Sanity emulator server.

```javascript
import { SanityServer } from "./services/sanity/src/server.js";

const server = new SanityServer(4842);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop the Monday Server

Source: https://parlel.com/docs/monday.md

Quick start example demonstrating how to initialize, start, and stop the monday.com API server.

```javascript
import { MondayServer } from "./services/monday/src/server.js";

const server = new MondayServer(4791);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start Build SDK Example

Source: https://parlel.com/docs/codebuild.md

This JavaScript example demonstrates how to use the AWS SDK to start a build using the CodeBuildClient. It connects to the local emulator and logs the build status.

```javascript
import { CodeBuildClient, StartBuildCommand } from "@aws-sdk/client-codebuild";

const cb = new CodeBuildClient({
  endpoint: "http://127.0.0.1:4742",
  region: "us-east-1",
  credentials: { accessKeyId: "parlel", secretAccessKey: "parlel" },
});

const out = await cb.send(new StartBuildCommand({ projectName: "my-project" }));
console.log(out.build.buildStatus); // "SUCCEEDED"
```

--------------------------------

### Start and Stop Box Server

Source: https://parlel.com/docs/box.md

Quick start example demonstrating how to initialize, start, and stop the Box server. Ensure the BoxServer is imported from the correct path.

```javascript
import { BoxServer } from "./services/box/src/server.js";

const server = new BoxServer(4837);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop YouTube Server

Source: https://parlel.com/docs/youtube.md

Quick start example demonstrating how to initialize, start, and stop the YoutubeServer. Ensure to await server start and stop operations.

```javascript
import { YoutubeServer } from "./services/youtube/src/server.js";

const server = new YoutubeServer(4803);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start Contentful Server

Source: https://parlel.com/docs/contentful.md

Quick start example to initialize and start the Contentful server. Ensure to stop the server after use.

```javascript
import { ContentfulServer } from "./services/contentful/src/server.js";

const server = new ContentfulServer(4841);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start Freshsales Server

Source: https://parlel.com/docs/freshsales.md

Quick start example to initialize and start the Freshsales server. Ensure to stop the server after use.

```javascript
import { FreshsalesServer } from "./services/freshsales/src/server.js";

const server = new FreshsalesServer(4783);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Quick Start: Using Parlel with Googleapis

Source: https://parlel.com/docs/google-docs.md

This snippet demonstrates how to start the Parlel emulator, configure the `googleapis` client to use the local server, and perform basic document operations like create, batch update, and get. Ensure the `googleapis` library is installed.

```javascript
import { google } from "googleapis";
import { GoogleDocsServer } from "./services/google-docs/src/server.js";

const server = new GoogleDocsServer(4616);
await server.start();

const docs = google.docs({ version: "v1", auth: "not-used-by-parlel" });
docs.context._options.rootUrl = "http://127.0.0.1:4616/";

const created = await docs.documents.create({
  requestBody: { title: "Parlel Notes" },
});

await docs.documents.batchUpdate({
  documentId: created.data.documentId,
  requestBody: {
    requests: [{ insertText: { location: { index: 1 }, text: "Hello from parlel\n" } }],
  },
});

const got = await docs.documents.get({ documentId: created.data.documentId });
console.log(got.data.body.content[0].paragraph.elements[0].textRun.content);

await server.stop();
```

--------------------------------

### Quick Start: Initialize and Start LaunchdarklyServer

Source: https://parlel.com/docs/launchdarkly.md

Initialize and start the LaunchdarklyServer. This is the first step to setting up the emulator for testing.

```javascript
import { LaunchdarklyServer } from "./services/launchdarkly/src/server.js";

const server = new LaunchdarklyServer(4816);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start PandaDoc Server

Source: https://parlel.com/docs/pandadoc.md

Quick start example to initialize and start the PandaDoc server on a specified port. Ensure to stop the server after use.

```javascript
import { PandadocServer } from "./services/pandadoc/src/server.js";

const server = new PandadocServer(4851);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Grafana Server

Source: https://parlel.com/docs/grafana.md

Quick start example demonstrating how to initialize, start, and stop the Grafana server in memory.

```javascript
import { GrafanaServer } from "./services/grafana/src/server.js";

const server = new GrafanaServer(4879);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start Recurly Server

Source: https://parlel.com/docs/recurly.md

Quick start example to initialize and start the RecurlyServer on a specified port. Ensure to stop the server after use.

```javascript
import { RecurlyServer } from "./services/recurly/src/server.js";

const server = new RecurlyServer(4870);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop CircleCI Server

Source: https://parlel.com/docs/circleci.md

Quick start example demonstrating how to initialize, start, and stop the CircleCI server in memory.

```javascript
import { CircleciServer } from "./services/circleci/src/server.js";

const server = new CircleciServer(4876);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Front API Server

Source: https://parlel.com/docs/front.md

Quick start example demonstrating how to initialize, start, and stop the Front API server. Ensure the server is properly managed during testing.

```javascript
import { FrontServer } from "./services/front/src/server.js";

const server = new FrontServer(4785);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop PayPal Server

Source: https://parlel.com/docs/paypal.md

Quick start example demonstrating how to initialize, start, and stop the PayPal server. Ensure the server is stopped after tests.

```javascript
import { PaypalServer } from "./services/paypal/src/server.js";

const server = new PaypalServer(4760);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start the Render Server

Source: https://parlel.com/docs/render.md

Instantiate and start the RenderServer on a specified port. This is the initial setup for using the emulator.

```javascript
import { RenderServer } from "./services/render/src/server.js";

const server = new RenderServer(4881);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Quick Start

Source: https://parlel.com/docs/freshbooks.md

Demonstrates how to initialize and start the FreshbooksServer for testing purposes.

```APIDOC
## Quick start

```js
import { FreshbooksServer } from "./services/freshbooks/src/server.js";

const server = new FreshbooksServer(4872);
await server.start();
// ... run your app/tests ...
await server.stop();
```
```

--------------------------------

### Start Calendly Server

Source: https://parlel.com/docs/calendly.md

Quick start example to initialize and start the Calendly server. Ensure to await server start and stop operations.

```javascript
import { CalendlyServer } from "./services/calendly/src/server.js";

const server = new CalendlyServer(4813);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Quick Start: Initialize and Start Server

Source: https://parlel.com/docs/pagerduty.md

Initialize and start the PagerDuty server. This is the first step to setting up the emulator for testing.

```javascript
import { PagerdutyServer } from "./services/pagerduty/src/server.js";

const server = new PagerdutyServer(4774);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Sentry Server

Source: https://parlel.com/docs/sentry.md

Quick start example demonstrating how to initialize, start, and stop the SentryServer. This is useful for setting up the fake API in your testing environment.

```javascript
import { SentryServer } from "./services/sentry/src/server.js";

const server = new SentryServer(4773);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Instagram Server

Source: https://parlel.com/docs/instagram.md

Quick start example for initializing and running the Instagram server. Ensure to await start and stop methods.

```javascript
import { InstagramServer } from "./services/instagram/src/server.js";

const server = new InstagramServer(4802);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop X Twitter Server

Source: https://parlel.com/docs/x-twitter.md

Quick start example to initialize and manage the X Twitter server. Ensure the server is started before running tests and stopped afterward.

```javascript
import { XTwitterServer } from "./services/x-twitter/src/server.js";

const server = new XTwitterServer(4800);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Quick Start

Source: https://parlel.com/docs/jotform.md

Demonstrates how to start the Jotform server and make a request to the /user/forms endpoint.

```APIDOC
## Quick start

```js
import { JotformServer } from "./services/jotform/src/server.js";

const server = new JotformServer(4846);
await server.start();
// ... run your app/tests ...
await server.stop();
```

Point a JotForm client at `http://127.0.0.1:4846`. Authenticate with either the
`APIKEY` header or the `?apiKey=` query parameter (any non-empty value is accepted).

```js
const res = await fetch("http://127.0.0.1:4846/user/forms", {
  headers: { APIKEY: "parlel" },
});
const { responseCode, message, content } = await res.json();
```
```

--------------------------------

### Start Voyage AI Server

Source: https://parlel.com/docs/voyage-ai.md

Quick start example for initializing and starting the Voyage AI server. Ensure to stop the server after use.

```javascript
import { VoyageAiServer } from "./services/voyage-ai/src/server.js";

const server = new VoyageAiServer(4865);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Reddit Server

Source: https://parlel.com/docs/reddit.md

Quick start example to initialize, start, and stop the in-memory Reddit server. Ensure to await the start and stop operations.

```javascript
import { RedditServer } from "./services/reddit/src/server.js";

const server = new RedditServer(4804);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Opsgenie Fake Server

Source: https://parlel.com/docs/opsgenie.md

Quick start example to initialize and manage the Opsgenie fake server. Ensure to import OpsgenieServer.

```javascript
import { OpsgenieServer } from "./services/opsgenie/src/server.js";

const server = new OpsgenieServer(4880);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### ElevenLabsServer Quick Start

Source: https://parlel.com/docs/elevenlabs.md

Demonstrates how to initialize and start the ElevenLabsServer for local testing.

```APIDOC
## ElevenLabsServer Quick Start

### Description
Initialize and start the ElevenLabsServer to create a local, in-memory fake of the ElevenLabs API for testing purposes.

### Usage
```js
import { ElevenlabsServer } from "./services/elevenlabs/src/server.js";

const server = new ElevenlabsServer(4753);
await server.start();
// ... run your app/tests ...
await server.stop();
```
```

--------------------------------

### Start and Stop Wise API Fake Server

Source: https://parlel.com/docs/wise.md

Quick start example demonstrating how to initialize, start, and stop the Wise API fake server. Ensure the server is properly managed during your application or test execution.

```javascript
import { WiseServer } from "./services/wise/src/server.js";

const server = new WiseServer(4867);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Linear Server

Source: https://parlel.com/docs/linear.md

Import and instantiate the LinearServer, then start and stop it. This is the basic setup for the fake API.

```javascript
import { LinearServer } from "./services/linear/src/server.js";

const server = new LinearServer(4788);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Mercury Server

Source: https://parlel.com/docs/mercury.md

Quick start example demonstrating how to import and use the MercuryServer class to start and stop the in-memory banking API fake.

```javascript
import { MercuryServer } from "./services/mercury/src/server.js";

const server = new MercuryServer(4875);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Gemini Server (Node.js)

Source: https://parlel.com/docs/google-gemini.md

Quick start example for initializing and managing the Google Gemini server in Node.js. Ensure the server is started before running tests and stopped afterwards.

```javascript
import { GoogleGeminiServer } from "./services/google-gemini/src/server.js";

const server = new GoogleGeminiServer(4749);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Razorpay Fake Server

Source: https://parlel.com/docs/razorpay.md

Quick start example to initialize, start, and stop the Razorpay fake server. Ensure the server is running before executing tests.

```javascript
import { RazorpayServer } from "./services/razorpay/src/server.js";

const server = new RazorpayServer(4761);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start PostHog Server

Source: https://parlel.com/docs/posthog.md

Initialize and start the PostHog server. This is the first step to setting up the emulator.

```javascript
import { PosthogServer } from "./services/posthog/src/server.js";

const server = new PosthogServer(4807);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start AWS Backup Job using SDK

Source: https://parlel.com/docs/backup.md

Example of initiating a backup job using the AWS SDK for JavaScript with the parlel emulator. Requires importing the necessary client and command.

```javascript
import { BackupClient, StartBackupJobCommand } from "@aws-sdk/client-backup";

const backup = new BackupClient({
  endpoint: "http://127.0.0.1:4741",
  region: "us-east-1",
  credentials: { accessKeyId: "parlel", secretAccessKey: "parlel" },
});

await backup.send(new StartBackupJobCommand({
  BackupVaultName: "Default",
  ResourceArn: "arn:aws:dynamodb:us-east-1:000000000000:table/orders",
  IamRoleArn: "arn:aws:iam::000000000000:role/backup",
}));
```

--------------------------------

### Start Adyen Server

Source: https://parlel.com/docs/adyen.md

Import and start the AdyenServer. Ensure to stop the server when done.

```javascript
import { AdyenServer } from "./services/adyen/src/server.js";

const server = new AdyenServer(4869);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start the Segment Server

Source: https://parlel.com/docs/segment.md

Instantiate and start the SegmentServer. This is the first step in setting up the emulator for testing.

```javascript
import { SegmentServer } from "./services/segment/src/server.js";

const server = new SegmentServer(4815);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Quick Start: Initialize and Use Qdrant Fake Server

Source: https://parlel.com/docs/qdrant.md

Demonstrates how to start the Qdrant fake server, create a collection, upsert points, perform a search, and then stop the server. Ensure the server is started before client operations and stopped afterward.

```javascript
import { QdrantServer } from "../services/qdrant/src/server.js";
import { QdrantClient } from "@qdrant/js-client-rest";

const server = new QdrantServer(6333);
await server.start();

const client = new QdrantClient({ url: "http://127.0.0.1:6333", checkCompatibility: false });
await client.createCollection("items", { vectors: { size: 4, distance: "Cosine" } });
await client.upsert("items", {
  wait: true,
  points: [{ id: 1, vector: [1, 0, 0, 0], payload: { name: "demo" } }],
});
const hits = await client.search("items", { vector: [1, 0, 0, 0], limit: 1 });

await server.stop();
```

--------------------------------

### Quick Start: Setting up and using NocoDB Server

Source: https://parlel.com/docs/nocodb.md

This snippet demonstrates how to initialize, start, and stop the NocoDB server. It also shows how to create a base, a table with a column, and add a record using axios.

```javascript
import axios from "axios";
import { NocodbServer } from "./services/nocodb/src/server.js";

const server = new NocodbServer(4612);
await server.start();

const client = axios.create({baseURL: "http://127.0.0.1:4612"});
const base = await client.post("/api/v2/meta/bases", { title: "CRM" });
const table = await client.post(`/api/v2/meta/bases/${base.data.id}/tables`, {
  title: "Contacts",
  columns: [{ title: "Name", uidt: "SingleLineText" }],
});
const record = await client.post(`/api/v2/tables/${table.data.id}/records`, { Name: "Ada" });

await server.stop();
```

--------------------------------

### Quick Start: Initialize and Use Google Drive Mock Server

Source: https://parlel.com/docs/google-drive.md

Demonstrates how to start the mock server, configure the `googleapis` client to use the mock server's URL, and perform a file creation operation. Ensure the server is stopped after use.

```javascript
import { google } from "googleapis";
import { GoogleDriveServer } from "./services/google-drive/src/server.js";

const server = new GoogleDriveServer(4614);
await server.start();

const drive = google.drive({ version: "v3", auth: "test" });
drive.context._options.rootUrl = "http://127.0.0.1:4614/";

const created = await drive.files.create({
  requestBody: { name: "notes.txt", mimeType: "text/plain" },
  media: { mimeType: "text/plain", body: "hello" },
});

await server.stop();
```

--------------------------------

### Quick Start: Initialize and Use Google Calendar Emulator

Source: https://parlel.com/docs/google-calendar.md

This snippet demonstrates how to set up and use the Google Calendar emulator with the `googleapis` library. It shows starting the server, configuring the client to use the emulator's root URL, and performing basic operations like creating a calendar and an event.

```javascript
import { google } from "googleapis";
import { GoogleCalendarServer } from "./services/google-calendar/src/server.js";

const server = new GoogleCalendarServer(4615);
await server.start();

const calendar = google.calendar({ version: "v3", auth: "not-used-by-parlel" });
calendar.context._options.rootUrl = "http://127.0.0.1:4615/";

const created = await calendar.calendars.insert({
  requestBody: { summary: "Engineering", timeZone: "UTC" },
});

await calendar.events.insert({
  calendarId: created.data.id,
  requestBody: {
    summary: "Planning",
    start: { dateTime: "2026-01-01T10:00:00.000Z" },
    end: { dateTime: "2026-01-01T11:00:00.000Z" },
  },
});

await server.stop();
```

--------------------------------

### Start Groq Server

Source: https://parlel.com/docs/groq.md

Initialize and start the Groq server on a specified port. Ensure to stop the server when done.

```javascript
import { GroqServer } from "./services/groq/src/server.js";

const server = new GroqServer(4750);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Secrets Manager Server

Source: https://parlel.com/docs/secretsmanager.md

Starts the Secrets Manager server on a specified port and stops it. This is the initial setup for using the fake Secrets Manager.

```javascript
import { SecretsmanagerServer } from "./services/secretsmanager/src/server.js";

const server = new SecretsmanagerServer(4572);
await server.start();
// ... use it ...
await server.stop();
```

--------------------------------

### Quick Start: Initialize and Send Email with Outlook Server

Source: https://parlel.com/docs/outlook.md

This snippet demonstrates how to start the Outlook server, initialize a Microsoft Graph client pointing to the fake server, send an email, and retrieve sent items. Ensure the OutlookServer is started before the client is initialized.

```javascript
import { OutlookServer } from "./services/outlook/src/server.js";
import { Client } from "@microsoft/microsoft-graph-client";

const server = new OutlookServer(4620);
await server.start();

const client = Client.init({
  baseUrl: "http://127.0.0.1:4620/v1.0",
  authProvider: (done) => done(null, "local-token"),
});

await client.api("/me/sendMail").post({
  message: {
    subject: "Hello from parlel",
    body: { contentType: "text", content: "Local only" },
    toRecipients: [{ emailAddress: { address: "agent@example.com" } }],
  },
  saveToSentItems: true,
});

const messages = await client.api("/me/mailFolders/sentitems/messages").get();
await server.stop();
```

--------------------------------

### SDK Evaluation Endpoint Example

Source: https://parlel.com/docs/launchdarkly.md

Example of how to call the SDK evaluation endpoint to get flag values for a given user. The user must be base64 encoded.

```javascript
GET /sdk/eval/:envKey/users/:base64user — evaluate all flags for a base64-encoded user. Returns { <flagKey>: { value, variation, version, trackEvents } }
```

--------------------------------

### Start Server and Send WhatsApp Messages

Source: https://parlel.com/docs/whatsapp.md

This snippet demonstrates how to initialize and start the WhatsappServer, then use axios to send both text and template messages via the WhatsApp API. It includes setup for authentication and message recipients.

```javascript
import { WhatsappServer } from "./services/whatsapp/src/server.js";
import axios from "axios";

const server = new WhatsappServer(4657);
await server.start();

const ACCESS_TOKEN = "parlel-test-access-token";
const PHONE_NUMBER_ID = "100000000000001";

const wa = axios.create({
  baseURL: "http://127.0.0.1:4657/v21.0",
  headers: { Authorization: `Bearer ${ACCESS_TOKEN}` },
});

// Send a text message
const { data } = await wa.post(`/${PHONE_NUMBER_ID}/messages`, {
  messaging_product: "whatsapp",
  recipient_type: "individual",
  to: "15551230000",
  type: "text",
  text: { body: "Hello from parlel!" },
});
console.log(data.messages[0].id); // "wamid.…"

// Send an approved template
await wa.post(`/${PHONE_NUMBER_ID}/messages`, {
  messaging_product: "whatsapp",
  to: "15551230000",
  type: "template",
  template: { name: "hello_world", language: { code: "en_US" } },
});

await server.stop();
```

--------------------------------

### Start Zendesk Fake Server

Source: https://parlel.com/docs/zendesk.md

Initializes and starts the fake Zendesk server on a specified port. This is the first step to setting up the testing environment.

```javascript
import { ZendeskServer } from "./services/zendesk/src/server.js";

const server = new ZendeskServer(4781);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### SDK Example: Create Broker

Source: https://parlel.com/docs/amazonmq.md

This JavaScript example demonstrates how to use the AWS SDK for JavaScript to create a broker using the parlel Amazon MQ emulator. Ensure you have the AWS SDK client for MQ installed.

```javascript
import { MqClient, CreateBrokerCommand } from "@aws-sdk/client-mq";

const mq = new MqClient({
  endpoint: "http://127.0.0.1:4738",
  region: "us-east-1",
  credentials: { accessKeyId: "parlel", secretAccessKey: "parlel" },
});

await mq.send(new CreateBrokerCommand({
  brokerName: "broker1",
  engineType: "RABBITMQ",
  deploymentMode: "SINGLE_INSTANCE",
  hostInstanceType: "mq.t3.micro",
  publiclyAccessible: false,
  users: [{ username: "admin", password: "secret9chars" }],
  autoMinorVersionUpgrade: true,
}));
```

--------------------------------

### SDK Example for Athena Operations

Source: https://parlel.com/docs/athena.md

This TypeScript example demonstrates how to use the AWS SDK to start a query execution and retrieve its results using the Athena emulator. Ensure the AthenaClient is configured with the emulator's endpoint and credentials.

```typescript
import {
  AthenaClient,
  StartQueryExecutionCommand,
  GetQueryResultsCommand,
} from "@aws-sdk/client-athena";

const athena = new AthenaClient({
  region: "us-east-1",
  endpoint: "http://127.0.0.1:4723",
  credentials: { accessKeyId: "parlel", secretAccessKey: "parlel" },
});

const { QueryExecutionId } = await athena.send(
  new StartQueryExecutionCommand({ QueryString: "SELECT 1" }),
);
const results = await athena.send(new GetQueryResultsCommand({ QueryExecutionId }));
```

--------------------------------

### Test Environment Configuration

Source: https://parlel.com/docs/paperform.md

Example environment variables for configuring the Paperform emulator in a testing setup. These are typically copied into a test.env file.

```env
PAPERFORM_API_KEY=parlel
PAPERFORM_BASE_URL=http://parlel-bridge:4855
```

--------------------------------

### Quick Start: Setting up and using the Teams Fake Server

Source: https://parlel.com/docs/teams.md

Demonstrates how to start the Teams fake server, configure the Microsoft Graph client to use its local endpoint, and perform basic operations like creating a team, channel, and sending a message. Ensure the server is stopped after use.

```javascript
import { TeamsServer } from "./services/teams/src/server.js";
import { Client } from "@microsoft/microsoft-graph-client";

const server = new TeamsServer(4621);
await server.start();

const client = Client.init({
  baseUrl: "http://127.0.0.1:4621/v1.0",
  authProvider: (done) => done(null, "local-token"),
});

const team = await client.api("/teams").post({
  displayName: "Local Team",
  description: "No Microsoft tenant required",
});

const channel = await client.api(`/teams/${team.id}/channels`).post({
  displayName: "agents",
});

await client.api(`/teams/${team.id}/channels/${channel.id}/messages`).post({
  body: { contentType: "text", content: "Hello from parlel" },
});

const messages = await client.api(`/teams/${team.id}/channels/${channel.id}/messages`).get();
await server.stop();
```

--------------------------------

### SQL Sequence Operations

Source: https://parlel.com/docs/postgres.md

Examples of SQL statements for interacting with sequences, including getting the next value, current value, and setting the value.

```sql
SELECT NEXTVAL('order_id_seq');
SELECT CURRVAL('order_id_seq');
SELECT SETVAL('order_id_seq', 2000);
```

--------------------------------

### Quick Start: Using Google Tasks API Emulator

Source: https://parlel.com/docs/google-tasks.md

Demonstrates how to start the emulator, interact with it using googleapis, and perform basic task list and task operations. Ensure the emulator is running before executing this code.

```javascript
import { google } from "googleapis";
import { GoogleTasksServer } from "./services/google-tasks/src/server.js";

const server = new GoogleTasksServer(4626);
await server.start();

const tasks = google.tasks({
  version: "v1",
  rootUrl: "http://127.0.0.1:4626/",
});

const list = await tasks.tasklists.insert({
  requestBody: { title: "Agent test list" },
});

await tasks.tasks.insert({
  tasklist: list.data.id,
  requestBody: { title: "Verify integration" },
});

const allTasks = await tasks.tasks.list({ tasklist: list.data.id });
console.log(allTasks.data.items);

await server.stop();
```

--------------------------------

### AWS SDK for JavaScript Example

Source: https://parlel.com/docs/cloudtrail.md

Demonstrates creating a trail, starting logging, and looking up events using the AWS SDK for JavaScript with the CloudTrail emulator.

```javascript
import {
  CloudTrailClient,
  CreateTrailCommand,
  StartLoggingCommand,
  LookupEventsCommand,
} from "@aws-sdk/client-cloudtrail";

const ct = new CloudTrailClient({
  region: "us-east-1",
  endpoint: "http://127.0.0.1:4734",
  credentials: { accessKeyId: "parlel", secretAccessKey: "parlel" },
});

await ct.send(new CreateTrailCommand({ Name: "audit", S3BucketName: "logs" }));
await ct.send(new StartLoggingCommand({ Name: "audit" }));
const { Events } = await ct.send(new LookupEventsCommand({}));
console.log(Events[0].EventName);
```

--------------------------------

### Quick Start: Airtable Emulator

Source: https://parlel.com/docs/airtable.md

Demonstrates how to start the Airtable emulator, configure the Airtable client to use the emulator's endpoint, and perform basic record operations. Ensure the emulator is running on the specified port before executing this code.

```javascript
import Airtable from "airtable";
import { AirtableServer } from "./services/airtable/src/server.js";

const server = new AirtableServer(4611);
await server.start();

const base = new Airtable({
  apiKey: "keyParlel",
  endpointUrl: "http://127.0.0.1:4611",
}).base("appParlel");

const created = await base("Tasks").create({ Name: "Test locally" });
const records = await base("Tasks").select({ pageSize: 10 }).all();

await server.stop();
```

--------------------------------

### Zendesk Test Environment Configuration

Source: https://parlel.com/docs/zendesk.md

Example environment variables for configuring the Zendesk fake API within a testing setup. These are typically copied into a `test.env` file.

```env
ZENDESK_API_TOKEN=pat-parlel
ZENDESK_BASE_URL=http://parlel-bridge:4781
```

--------------------------------

### Auth0 Emulator Configuration for Testing

Source: https://parlel.com/docs/auth0.md

Example environment variables for configuring the Auth0 emulator within a testing setup. These values are used by the bridge sidecar flow.

```env
AUTH0_DOMAIN=parlel-bridge:4817
AUTH0_CLIENT_ID=parlel
AUTH0_CLIENT_SECRET=parlel
AUTH0_BASE_URL=http://parlel-bridge:4817
```

--------------------------------

### Start the ElevenLabs Server

Source: https://parlel.com/docs/elevenlabs.md

Initialize and start the ElevenLabsServer. This is the first step to setting up the fake API.

```javascript
import { ElevenlabsServer } from "./services/elevenlabs/src/server.js";

const server = new ElevenlabsServer(4753);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Installed Apps

Source: https://parlel.com/docs/teams.md

Manages installed applications within teams and chats, including listing, installing, upgrading, and deleting apps.

```APIDOC
## GET /v1.0/teams/{teamId}/installedApps

### Description
Lists installed apps for a team.

### Method
GET

### Endpoint
/v1.0/teams/{teamId}/installedApps

## POST /v1.0/teams/{teamId}/installedApps

### Description
Installs an app for a team.

### Method
POST

### Endpoint
/v1.0/teams/{teamId}/installedApps

## GET /v1.0/teams/{teamId}/installedApps/{appId}

### Description
Gets a specific installed app for a team.

### Method
GET

### Endpoint
/v1.0/teams/{teamId}/installedApps/{appId}

## POST /v1.0/teams/{teamId}/installedApps/{appId}/upgrade

### Description
Updates the stored app version for a team-installed app and returns `204`.

### Method
POST

### Endpoint
/v1.0/teams/{teamId}/installedApps/{appId}/upgrade

## DELETE /v1.0/teams/{teamId}/installedApps/{appId}

### Description
Deletes an installed app from a team.

### Method
DELETE

### Endpoint
/v1.0/teams/{teamId}/installedApps/{appId}

## GET /v1.0/chats/{chatId}/installedApps

### Description
Lists installed apps for a chat.

### Method
GET

### Endpoint
/v1.0/chats/{chatId}/installedApps

## POST /v1.0/chats/{chatId}/installedApps

### Description
Installs an app for a chat.

### Method
POST

### Endpoint
/v1.0/chats/{chatId}/installedApps

## GET /v1.0/chats/{chatId}/installedApps/{appId}

### Description
Gets a specific installed app for a chat.

### Method
GET

### Endpoint
/v1.0/chats/{chatId}/installedApps/{appId}

## POST /v1.0/chats/{chatId}/installedApps/{appId}/upgrade

### Description
Updates the stored app version for a chat-installed app and returns `204`.

### Method
POST

### Endpoint
/v1.0/chats/{chatId}/installedApps/{appId}/upgrade

## DELETE /v1.0/chats/{chatId}/installedApps/{appId}

### Description
Deletes an installed app from a chat.

### Method
DELETE

### Endpoint
/v1.0/chats/{chatId}/installedApps/{appId}
```

--------------------------------

### Start PropelAuth Fake Server

Source: https://parlel.com/docs/propelauth.md

Initialize and start the PropelAuth fake server on a specified port. Ensure to stop the server when done.

```javascript
import { PropelauthServer } from "./services/propelauth/src/server.js";

const server = new PropelauthServer(4825);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start Amplitude Server

Source: https://parlel.com/docs/amplitude.md

Initialize and start the AmplitudeServer on a specified port. This is the first step to setting up the fake server for testing.

```javascript
import { AmplitudeServer } from "./services/amplitude/src/server.js";

const server = new AmplitudeServer(4809);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start New Relic Server

Source: https://parlel.com/docs/new-relic.md

Initialize and start the New Relic server. Ensure to await server start and stop operations.

```javascript
import { NewRelicServer } from "./services/new-relic/src/server.js";

const server = new NewRelicServer(4878);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start SurveyMonkey Server

Source: https://parlel.com/docs/surveymonkey.md

Initializes and starts the SurveyMonkey fake server on a specified port. Ensure to await server start and stop operations.

```javascript
import { SurveymonkeyServer } from "./services/surveymonkey/src/server.js";

const server = new SurveymonkeyServer(4847);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start and Stop Tally Server

Source: https://parlel.com/docs/tally.md

Quickly start and stop an instance of the TallyServer for testing purposes. Ensure to await both start and stop operations.

```javascript
import { TallyServer } from "./services/tally/src/server.js";

const server = new TallyServer(4848);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Start Cohere Server

Source: https://parlel.com/docs/cohere.md

Initialize and start the Cohere server on a specified port. This is the first step to setting up the emulator.

```javascript
import { CohereServer } from "./services/cohere/src/server.js";

const server = new CohereServer(4754);
await server.start();
// ... run your app/tests ...
await server.stop();
```

--------------------------------

### Users Labels Get

Source: https://parlel.com/docs/gmail.md

Gets the specified label.

```APIDOC
## GET /gmail/v1/users/{userId}/labels/{id}

### Description
Gets the specified label.

### Method
GET

### Endpoint
/gmail/v1/users/{userId}/labels/{id}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The user's email address. The special value 'me' can be used to indicate the authenticated user.
- **id** (string) - Required - The ID of the label to retrieve.
```
Tokens:
Raw