Typescript SDK

Complete Gym Management Platform.

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

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 zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

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

const pushPress = new PushPress();

async function run() {
  await pushPress.checkinCreatedEvent({
    data: {
      id: "chk_12345",
      customer: "usr_12345",
      company: "cli_12345",
      name: "My Class",
      typeId: "cit_12345",
      type: {
        id: "cit_12345",
        name: "Group HIIT Training",
      },
      timestamp: 1672531200000,
      role: "attendee",
    },
    created: 420989,
    event: "checkin.created",
  });
}

run();

Available Resources and Operations

Available methods

apiKeys

get - Get API Key
revoke - Revoke an API Key

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

company

get - Get Company Details

customers

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

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
activate - Activate a Webhook
rotateSecret - Rotate a Webhook Signing Secret

messages

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

PushPress SDK

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

apiKeysGet - Get API Key
apiKeysRevoke - Revoke an API Key
appInstalledEvent
appointmentCanceledEvent
appointmentNoShowedEvent
appointmentRescheduledEvent
appointmentScheduledEvent
appUninstalledEvent
checkinCreatedEvent
checkinDeletedEvent
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
checkinUpdatedEvent
classCanceledEvent
classesGet - Get Details for a Class
companyGet - Get Company Details
customerCreatedEvent
customerDeletedEvent
customerDetailsChangedEvent
customersCreate - Create a new Customer
customersGet - Get Customer Details
customersList - List Customers
customerStatusChangedEvent
enrollmentCreatedEvent
enrollmentDeleted
enrollmentStatusChanged
keysCreate - Create a new API Key
keysList - List API Keys
manageWebhooksActivate - Activate a Webhook
manageWebhooksCreate - Create 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
reservationCanceledEvent
reservationCreatedEvent
reservationWaitlistedEvent

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({
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

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

  for await (const page of result) {
    // Handle the page
    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();

async function run() {
  await pushPress.checkinCreatedEvent({
    data: {
      id: "chk_12345",
      customer: "usr_12345",
      company: "cli_12345",
      name: "My Class",
      typeId: "cit_12345",
      type: {
        id: "cit_12345",
        name: "Group HIIT Training",
      },
      timestamp: 1672531200000,
      role: "attendee",
    },
    created: 420989,
    event: "checkin.created",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });
}

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,
  },
});

async function run() {
  await pushPress.checkinCreatedEvent({
    data: {
      id: "chk_12345",
      customer: "usr_12345",
      company: "cli_12345",
      name: "My Class",
      typeId: "cit_12345",
      type: {
        id: "cit_12345",
        name: "Group HIIT Training",
      },
      timestamp: 1672531200000,
      role: "attendee",
    },
    created: 420989,
    event: "checkin.created",
  });
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the get method may throw the following errors:

Error Type	Status Code	Content Type
errors.NotFound	404	application/json
errors.Unauthorized	401, 403, 407	application/json
errors.Timeout	408	application/json
errors.RateLimited	429	application/json
errors.BadRequest	400, 413, 414, 415, 422, 431	application/json
errors.Timeout	504	application/json
errors.NotFound	501, 505	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.BadRequest	510	application/json
errors.Unauthorized	511	application/json
errors.APIError	4XX, 5XX	/

If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.

import { PushPress } from "@pushpress/pushpress";
import {
  BadRequest,
  InternalServerError,
  NotFound,
  RateLimited,
  SDKValidationError,
  Timeout,
  Unauthorized,
} from "@pushpress/pushpress/models/errors";

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

async function run() {
  let result;
  try {
    result = await pushPress.company.get({});

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof NotFound): {
        // Handle err.data$: NotFoundData
        console.error(err);
        return;
      }
      case (err instanceof Unauthorized): {
        // Handle err.data$: UnauthorizedData
        console.error(err);
        return;
      }
      case (err instanceof Timeout): {
        // Handle err.data$: TimeoutData
        console.error(err);
        return;
      }
      case (err instanceof RateLimited): {
        // Handle err.data$: RateLimitedData
        console.error(err);
        return;
      }
      case (err instanceof BadRequest): {
        // Handle err.data$: BadRequestData
        console.error(err);
        return;
      }
      case (err instanceof Timeout): {
        // Handle err.data$: TimeoutData
        console.error(err);
        return;
      }
      case (err instanceof NotFound): {
        // Handle err.data$: NotFoundData
        console.error(err);
        return;
      }
      case (err instanceof InternalServerError): {
        // Handle err.data$: InternalServerErrorData
        console.error(err);
        return;
      }
      case (err instanceof BadRequest): {
        // Handle err.data$: BadRequestData
        console.error(err);
        return;
      }
      case (err instanceof Unauthorized): {
        // Handle err.data$: UnauthorizedData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

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

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
`production`	`https://api.pushpress.com/v3`
`staging`	`https://api.pushpressstage.com/v3`
`development`	`https://api.pushpressdev.com/v3`

Example

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

const pushPress = new PushPress({
  server: "development",
});

async function run() {
  await pushPress.checkinCreatedEvent({
    data: {
      id: "chk_12345",
      customer: "usr_12345",
      company: "cli_12345",
      name: "My Class",
      typeId: "cit_12345",
      type: {
        id: "cit_12345",
        name: "Group HIIT Training",
      },
      timestamp: 1672531200000,
      role: "attendee",
    },
    created: 420989,
    event: "checkin.created",
  });
}

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",
});

async function run() {
  await pushPress.checkinCreatedEvent({
    data: {
      id: "chk_12345",
      customer: "usr_12345",
      company: "cli_12345",
      name: "My Class",
      typeId: "cit_12345",
      type: {
        id: "cit_12345",
        name: "Group HIIT Training",
      },
      timestamp: 1672531200000,
      role: "attendee",
    },
    created: 420989,
    event: "checkin.created",
  });
}

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 });

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"] ?? "",
});

async function run() {
  await pushPress.checkinCreatedEvent({
    data: {
      id: "chk_12345",
      customer: "usr_12345",
      company: "cli_12345",
      name: "My Class",
      typeId: "cit_12345",
      type: {
        id: "cit_12345",
        name: "Group HIIT Training",
      },
      timestamp: 1672531200000,
      role: "attendee",
    },
    created: 420989,
    event: "checkin.created",
  });
}

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();

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

  // Handle the result
  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 45 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
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

PushPress/pushpress-ts

Folders and files

Latest commit

History

Repository files navigation

Typescript SDK

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example

Available Resources and Operations

Standalone functions

Pagination

Retries

Error Handling

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

Stars

Watchers

Forks

Languages