One API to post to Facebook, Instagram, LinkedIn, LinkedIn Pages, Pinterest, TikTok, X (formerly Twitter) and YouTube. This SDK offers a convenient and type-safe wrapper for WoopSocial's OpenAPI specification.

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Authentication
• Available Resources and Operations
• Standalone functions
• File uploads
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @woopsocial/typescript-sdk

PNPM

pnpm add @woopsocial/typescript-sdk

Bun

bun add @woopsocial/typescript-sdk

Yarn

yarn add @woopsocial/typescript-sdk

[!NOTE] This package is published as a dual-module package, supporting both ES Module (ESM) and CommonJS (CJS) consumers. ESM and CJS builds are available under dist/esm and dist/commonjs respectively, and the correct build is resolved automatically via the package's exports map.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { WoopSocial } from "@woopsocial/typescript-sdk";

const woopSocial = new WoopSocial({
  apiKey: process.env["WOOPSOCIAL_API_KEY"] ?? "",
});

async function run() {
  const result = await woopSocial.posts.createPost({
    content: [],
    schedule: {
      type: "DRAFT",
    },
    socialAccounts: [],
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------- | ---- | ----------- | -------------------- | | apiKey | http | HTTP Bearer | WOOPSOCIAL_API_KEY |

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { WoopSocial } from "@woopsocial/typescript-sdk";

const woopSocial = new WoopSocial({
  apiKey: process.env["WOOPSOCIAL_API_KEY"] ?? "",
});

async function run() {
  const result = await woopSocial.posts.createPost({
    content: [],
    schedule: {
      type: "DRAFT",
    },
    socialAccounts: [],
  });

  console.log(result);
}

run();

Available Resources and Operations

Health

• getHealth - Health check

Media

• createMedia - Upload media
• createUploadSession - Start media upload session
• getUploadSession - Get media upload session status
• completeUploadSession - Complete media upload session

Posts

• createPost - Create post
• validatePost - Validate post
• getPost - Get post
• deletePost - Delete post
• listSocialAccountPosts - List social account posts

Projects

• listProjects - List projects

SocialAccounts

• createOAuthAuthorization - Generate OAuth URL
• listSocialAccounts - List social accounts
• getSocialAccountPlatformInputs - Get platform-specific input options

Webhooks

• createWebhookEndpoint - Register webhook endpoint
• listWebhookEndpoints - List webhook endpoints
• deleteWebhookEndpoint - Delete webhook endpoint

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• healthGetHealth - Health check
• mediaCompleteUploadSession - Complete media upload session
• mediaCreateMedia - Upload media
• mediaCreateUploadSession - Start media upload session
• mediaGetUploadSession - Get media upload session status
• postsCreatePost - Create post
• postsDeletePost - Delete post
• postsGetPost - Get post
• postsListSocialAccountPosts - List social account posts
• postsValidatePost - Validate post
• projectsListProjects - List projects
• socialAccountsCreateOAuthAuthorization - Generate OAuth URL
• socialAccountsGetSocialAccountPlatformInputs - Get platform-specific input options
• socialAccountsListSocialAccounts - List social accounts
• webhooksCreateWebhookEndpoint - Register webhook endpoint
• webhooksDeleteWebhookEndpoint - Delete webhook endpoint
• webhooksListWebhookEndpoints - List webhook endpoints

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { WoopSocial } from "@woopsocial/typescript-sdk";
import { openAsBlob } from "node:fs";

const woopSocial = new WoopSocial({
  apiKey: process.env["WOOPSOCIAL_API_KEY"] ?? "",
});

async function run() {
  const result = await woopSocial.media.createMedia({
    projectId: "<id>",
    body: await openAsBlob("example.file"),
  });

  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { WoopSocial } from "@woopsocial/typescript-sdk";

const woopSocial = new WoopSocial({
  apiKey: process.env["WOOPSOCIAL_API_KEY"] ?? "",
});

async function run() {
  const result = await woopSocial.posts.createPost({
    content: [],
    schedule: {
      type: "DRAFT",
    },
    socialAccounts: [],
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { WoopSocial } from "@woopsocial/typescript-sdk";

const woopSocial = new WoopSocial({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: process.env["WOOPSOCIAL_API_KEY"] ?? "",
});

async function run() {
  const result = await woopSocial.posts.createPost({
    content: [],
    schedule: {
      type: "DRAFT",
    },
    socialAccounts: [],
  });

  console.log(result);
}

run();

Error Handling

WoopSocialError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { WoopSocial } from "@woopsocial/typescript-sdk";
import * as errors from "@woopsocial/typescript-sdk/models/errors";

const woopSocial = new WoopSocial({
  apiKey: process.env["WOOPSOCIAL_API_KEY"] ?? "",
});

async function run() {
  try {
    const result = await woopSocial.posts.createPost({
      content: [],
      schedule: {
        type: "DRAFT",
      },
      socialAccounts: [],
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.WoopSocialError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.CreatePostErrorResponse) {
        console.log(error.data$.code); // models.CreatePostErrorCode
        console.log(error.data$.message); // string
        console.log(error.data$.validationErrors); // ValidationError[]
        console.log(error.data$.conflictingSocialAccountIds); // string[]
      }
    }
  }
}

run();

Error Classes

Primary error:

• WoopSocialError: The base class for HTTP error responses.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from WoopSocialError:

• CreatePostErrorResponse: Applicable to 2 of 17 methods.*
• DeletePostErrorResponse: Post not found. Applicable to 1 of 17 methods.*
• GetPostErrorResponse: Post not found. Applicable to 1 of 17 methods.*
• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { WoopSocial } from "@woopsocial/typescript-sdk";

const woopSocial = new WoopSocial({
  serverURL: "https://api.woopsocial.com/v1",
  apiKey: process.env["WOOPSOCIAL_API_KEY"] ?? "",
});

async function run() {
  const result = await woopSocial.posts.createPost({
    content: [],
    schedule: {
      type: "DRAFT",
    },
    socialAccounts: [],
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { WoopSocial } from "@woopsocial/typescript-sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@woopsocial/typescript-sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new WoopSocial({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { WoopSocial } from "@woopsocial/typescript-sdk";

const sdk = new WoopSocial({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable WOOPSOCIAL_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy