[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

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.

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• Pagination
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Debugging

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

async function run() {
  const result = await pushPress.checkins.event.get({
    uuid: "b888f774-3e7c-4135-a18c-6b985523c4bc",
  });

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

apiKeys

• get - Get a key by its ID
• revoke - Revoke an API Key

checkins

checkins.appointment

• get - Get an appointment checkin
• list - Get a list of appointment checkins

checkins.class

• get - Get an event checkin
• list - Get a list of class checkins

checkins.event

• get - Get a class checkin
• list - Get a list of event checkins

company

• get - Get company information

customers

• get - Get individual customer information
• list - Get a list of customers

keys

• create - Create a new API Key
• list - Get a list of active keys in a given company

messages

messages.email

• send - Send an email

messages.push

• send - Send an PushNotification

messages.realtime

• send - Send an event via Ably Realtime

messages.sms

• send - Send an SMS

webhooks

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

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.

• apiKeysGet - Get a key by its ID
• apiKeysRevoke - Revoke an API Key
• checkinsAppointmentGet - Get an appointment checkin
• checkinsAppointmentList - Get a list of appointment checkins
• checkinsClassGet - Get an event checkin
• checkinsClassList - Get a list of class checkins
• checkinsEventGet - Get a class checkin
• checkinsEventList - Get a list of event checkins
• companyGet - Get company information
• customersGet - Get individual customer information
• customersList - Get a list of customers
• keysCreate - Create a new API Key
• keysList - Get a list of active keys in a given company
• messagesEmailSend - Send an email
• messagesPushSend - Send an PushNotification
• messagesRealtimeSend - Send an event via Ably Realtime
• messagesSmsSend - Send an SMS
• webhooksActivate - Activate a Platform Webhook
• webhooksCreate - Create a Platform Webhook
• webhooksDelete - Delete a Platform Webhook
• webhooksGet - Get a Platform Webhook
• webhooksList - List Platform Webhooks
• webhooksRotateSecret - Rotate a Platform Webhook Signing Secret
• webhooksUpdate - Update a Platform Webhook

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

async function run() {
  const result = await pushPress.checkins.event.get({
    uuid: "b888f774-3e7c-4135-a18c-6b985523c4bc",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  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,
  },
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushPress.checkins.event.get({
    uuid: "b888f774-3e7c-4135-a18c-6b985523c4bc",
  });

  // Handle the result
  console.log(result);
}

run();

Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.APIError.

If a HTTP request fails, an operation my also throw an error from 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 |

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the get method may throw the following errors:

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

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) {
      case (err instanceof SDKValidationError): {
        // Validation errors can be pretty-printed
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        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;
      }
      case (err instanceof NotFound): {
        // Handle err.data$: NotFoundData
        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 InternalServerError): {
        // Handle err.data$: InternalServerErrorData
        console.error(err);
        return;
      }
      default: {
        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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.

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

async function run() {
  const result = await pushPress.checkins.event.get({
    uuid: "b888f774-3e7c-4135-a18c-6b985523c4bc",
  });

  // Handle the result
  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",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushPress.checkins.event.get({
    uuid: "b888f774-3e7c-4135-a18c-6b985523c4bc",
  });

  // Handle the result
  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 });

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() {
  const result = await pushPress.checkins.event.get({
    uuid: "b888f774-3e7c-4135-a18c-6b985523c4bc",
  });

  // Handle the result
  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();

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.