Typescript SDK

Complete Gym Management Platform.

Developer-friendly & type-safe Typescript SDK specifically catered to leverage the PushPress API.

🚧 Under Construction 🚧

This SDK is currently in early alpha and is not yet production-ready. We're actively working on improvements. Since we are making changes quickly, be aware that breaking changes may occur as we continue to develop and refine the SDK.

If you have specific requests or feedback, please feel free to file an issue.

Summary

PushPress Platform API: The PushPress Platform API provides a comprehensive suite of endpoints designed to facilitate seamless integration with the PushPress ecosystem. This API allows developers to interact programmatically with the PushPress platform, enabling the automation of various tasks and the extension of platform capabilities.

SDK Installation

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

NPM

npm add @pushpress/pushpress

PNPM

pnpm add @pushpress/pushpress

Bun

bun add @pushpress/pushpress

Yarn

yarn add @pushpress/pushpress

Note

This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "PushPress": {
      "command": "npx",
      "args": [
        "-y", "--package", "@pushpress/pushpress",
        "--",
        "mcp", "start",
        "--api-key", "...",
        "--company-id", "..."
      ]
    }
  }
}

Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "PushPress": {
      "command": "npx",
      "args": [
        "-y", "--package", "@pushpress/pushpress",
        "--",
        "mcp", "start",
        "--api-key", "...",
        "--company-id", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @pushpress/pushpress -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { PushPress } from "@pushpress/pushpress";

const pushPress = new PushPress({
  companyId: "<id>",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushPress.appointments.appointmentsGet({
    id: "<id>",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

APIKeys

get - Get API Key
delete - Delete an API Key
~~revoke~~ - Revoke an API Key ⚠️ Deprecated

Appointments

appointmentsGet - Get details for an appointment

Checkins

count - Get Checkin Count

Checkins.Appointment

get - Get Appointment Checkin Details
list - List Appointment Checkins

Checkins.Class

get - Get Class Checkin Details
list - List Class Checkins

Checkins.Event

get - Get Event Checkin Details
list - List Event Checkins

Checkins.Open

get - Get Open Facility Details
list - List Open Checkins

Classes

get - Get Details for a Class

Classes.Type

get - Get a class type
list - List class types for the given gym

Company

get - Get Company Details

Customers

create - Create a new Customer
list - List Customers
get - Get Customer Details

Customers.Attributions

create - Create a customer attribution
list - List customer attributions
get - Get a customer attribution

Enrollment

get - Get Plan Enrollment Details
list - List Plan Enrollments

Events

get - Get details for an event
list - List Events

Invitations

get - Get an invitation
delete - Delete an invitation
list - List Invitations
create - Create Invitations

Keys

create - Create a new API Key
list - List API Keys

ManageWebhooks

create - Create a Webhook
list - List Webhooks
get - Get Webhook Details
update - Update a Webhook
delete - Delete a Webhook
deactivate - Deactivate a Webhook
activate - Activate a Webhook
rotateSecret - Rotate a Webhook Signing Secret

Messages.Email

send - Send an Email

Messages.Push

send - Send Push Notification

Messages.Realtime

send - Send Ably Realtime Event

Messages.Sms

send - Send an SMS

Plans

get - Get Plan details

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.

Available standalone functions

apiKeysDelete - Delete an API Key
apiKeysGet - Get API Key
appointmentsAppointmentsGet - Get details for an appointment
checkinsAppointmentGet - Get Appointment Checkin Details
checkinsAppointmentList - List Appointment Checkins
checkinsClassGet - Get Class Checkin Details
checkinsClassList - List Class Checkins
checkinsCount - Get Checkin Count
checkinsEventGet - Get Event Checkin Details
checkinsEventList - List Event Checkins
checkinsOpenGet - Get Open Facility Details
checkinsOpenList - List Open Checkins
classesGet - Get Details for a Class
classesTypeGet - Get a class type
classesTypeList - List class types for the given gym
companyGet - Get Company Details
customersAttributionsCreate - Create a customer attribution
customersAttributionsGet - Get a customer attribution
customersAttributionsList - List customer attributions
customersCreate - Create a new Customer
customersGet - Get Customer Details
customersList - List Customers
enrollmentGet - Get Plan Enrollment Details
enrollmentList - List Plan Enrollments
eventsGet - Get details for an event
eventsList - List Events
invitationsCreate - Create Invitations
invitationsDelete - Delete an invitation
invitationsGet - Get an invitation
invitationsList - List Invitations
keysCreate - Create a new API Key
keysList - List API Keys
manageWebhooksActivate - Activate a Webhook
manageWebhooksCreate - Create a Webhook
manageWebhooksDeactivate - Deactivate a Webhook
manageWebhooksDelete - Delete a Webhook
manageWebhooksGet - Get Webhook Details
manageWebhooksList - List Webhooks
manageWebhooksRotateSecret - Rotate a Webhook Signing Secret
manageWebhooksUpdate - Update a Webhook
messagesEmailSend - Send an Email
messagesPushSend - Send Push Notification
messagesRealtimeSend - Send Ably Realtime Event
messagesSmsSend - Send an SMS
plansGet - Get Plan details
~~apiKeysRevoke~~ - Revoke an API Key ⚠️ Deprecated

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { PushPress } from "@pushpress/pushpress";

const pushPress = new PushPress({
  companyId: "<id>",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushPress.customers.list({});

  for await (const page of result) {
    console.log(page);
  }
}

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 { PushPress } from "@pushpress/pushpress";

const pushPress = new PushPress({
  companyId: "<id>",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushPress.appointments.appointmentsGet({
    id: "<id>",
  }, {
    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 { PushPress } from "@pushpress/pushpress";

const pushPress = new PushPress({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  companyId: "<id>",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushPress.appointments.appointmentsGet({
    id: "<id>",
  });

  console.log(result);
}

run();

Error Handling

PushPressError 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 { PushPress } from "@pushpress/pushpress";
import * as errors from "@pushpress/pushpress/models/errors";

const pushPress = new PushPress({
  companyId: "<id>",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  try {
    const result = await pushPress.customers.list({});

    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.PushPressError) {
      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.NotFound) {
        console.log(error.data$.message); // string
        console.log(error.data$.additionalProperties); // { [k: string]: any }
      }
    }
  }
}

run();

Error Classes

Primary error:

PushPressError: The base class for HTTP error responses.

Less common errors (12)

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 PushPressError:

BadRequest: A collection of codes that generally means the end user got something wrong in making the request. Applicable to 8 of 46 methods.*
Unauthorized: A collection of codes that generally means the client was not authenticated correctly for the request they want to make. Applicable to 8 of 46 methods.*
NotFound: Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing. Applicable to 8 of 46 methods.*
Timeout: Timeouts occurred with the request. Applicable to 8 of 46 methods.*
RateLimited: Status codes relating to the client being rate limited by the server. Status code 429. Applicable to 8 of 46 methods.*
InternalServerError: A collection of status codes that generally mean the server failed in an unexpected way. Applicable to 8 of 46 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

Select Server by Name

You can override the default server globally by passing a server name to the server: keyof typeof ServerList optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Name	Server	Description
`production`	`https://api.pushpress.com/v3`	production
`staging`	`https://api.pushpressstage.com/v3`	staging
`development`	`https://api.pushpressdev.com/v3`	development

Example

import { PushPress } from "@pushpress/pushpress";

const pushPress = new PushPress({
  server: "production",
  companyId: "<id>",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushPress.appointments.appointmentsGet({
    id: "<id>",
  });

  console.log(result);
}

run();

Override Server URL Per-Client

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

import { PushPress } from "@pushpress/pushpress";

const pushPress = new PushPress({
  serverURL: "https://api.pushpress.com/v3",
  companyId: "<id>",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushPress.appointments.appointmentsGet({
    id: "<id>",
  });

  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 use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { PushPress } from "@pushpress/pushpress";
import { HTTPClient } from "@pushpress/pushpress/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

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 PushPress({ httpClient: httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`apiKey`	apiKey	API key	`PUSHPRESS_API_KEY`

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

import { PushPress } from "@pushpress/pushpress";

const pushPress = new PushPress({
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
  companyId: "<id>",
});

async function run() {
  const result = await pushPress.appointments.appointmentsGet({
    id: "<id>",
  });

  console.log(result);
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { PushPress } from "@pushpress/pushpress";

const pushPress = new PushPress({
  companyId: "<id>",
});

async function run() {
  const result = await pushPress.keys.create({
    bearer: process.env["PUSHPRESS_BEARER"] ?? "",
  }, {
    requestBody: {
      name: "my-key",
      description: "my key",
      expiresAt: 1672531200000,
    },
  });

  console.log(result);
}

run();

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 { PushPress } from "@pushpress/pushpress";

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

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

Name		Name	Last commit message	Last commit date
Latest commit History 132 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
examples		examples
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.nvmrc		.nvmrc
CONTRIBUTING.md		CONTRIBUTING.md
FUNCTIONS.md		FUNCTIONS.md
README.md		README.md
RELEASES.md		RELEASES.md
RUNTIMES.md		RUNTIMES.md
USAGE.md		USAGE.md
eslint.config.mjs		eslint.config.mjs
jsr.json		jsr.json
package-lock.json		package-lock.json
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
tsconfig.json		tsconfig.json
tsconfig.tsbuildinfo		tsconfig.tsbuildinfo

PushPress/pushpress-ts

Folders and files

Latest commit

History

Repository files navigation

Typescript SDK

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Model Context Protocol (MCP) Server

Requirements

SDK Example Usage

Example

Available Resources and Operations

Standalone functions

Pagination

Retries

Error Handling

Example

Error Classes

Server Selection

Select Server by Name

Example

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Per-Operation Security Schemes

Debugging

About

Resources

Contributing

Uh oh!

Stars

Watchers

Forks

Uh oh!

Uh oh!

Uh oh!

Languages