Typescript SDK

The Solution for Bringing In More Members.

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

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

SDK Installation

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

NPM

npm add https://github.com/speakeasy-sdks/pushpress-typescript-sdk

PNPM

pnpm add https://github.com/speakeasy-sdks/pushpress-typescript-sdk

Bun

bun add https://github.com/speakeasy-sdks/pushpress-typescript-sdk

Yarn

yarn add https://github.com/speakeasy-sdks/pushpress-typescript-sdk zod

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

Note

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

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Pushpress } from "pushpress";

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

async function run() {
  const result = await pushpress.apps.list();

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

run();

Available Resources and Operations

Available methods

apiKeys

revoke - Revoke an API key
delete - Permanently delete an API key

apps

list - List all available apps
get - Get details of a specific app
install - Install an app for a company

apps.installs

list - List all installs of a specific app
uninstall - Soft uninstall an app (mark it as uninstalled but retain data)
hardDelete - Hard delete an app (remove all data)
get - Get details of a specific app install

checkins

list - Get a list of all check-ins
get - Get a check-in by ID

companies

get - Get company details associated with the API key

customers

list - Get a list of all customers in a
get - Get a customer by ID

keys

create - Create a new API key for a company
list - List all active API keys for a client
get - Retrieve a single API key

messages

messages.notifications

sendPing - Send a ping notification via Ably Realtime

webhooks

create - Create a new webhook to subscribe to one or more events
list - List all registered webhooks
get - Get details of a specific webhook
update - Update the URL or events for an existing webhook
delete - Delete a specific webhook

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 - Permanently delete an API key
apiKeysRevoke - Revoke an API key
appsGet - Get details of a specific app
appsInstall - Install an app for a company
appsInstallsGet - Get details of a specific app install
appsInstallsHardDelete - Hard delete an app (remove all data)
appsInstallsList - List all installs of a specific app
appsInstallsUninstall - Soft uninstall an app (mark it as uninstalled but retain data)
appsList - List all available apps
checkinsGet - Get a check-in by ID
checkinsList - Get a list of all check-ins
companiesGet - Get company details associated with the API key
customersGet - Get a customer by ID
customersList - Get a list of all customers in a
keysCreate - Create a new API key for a company
keysGet - Retrieve a single API key
keysList - List all active API keys for a client
messagesEmailSend - Send an email
messagesNotificationsSendPing - Send a ping notification via Ably Realtime
messagesPushSend - Send a push notification
webhooksCreate - Create a new webhook to subscribe to one or more events
webhooksDelete - Delete a specific webhook
webhooksGet - Get details of a specific webhook
webhooksList - List all registered webhooks
webhooksUpdate - Update the URL or events for an existing 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";

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

async function run() {
  const result = await pushpress.apps.installs.list({
    appId: "<id>",
  });

  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";

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

async function run() {
  const result = await pushpress.apps.list({
    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";

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.apps.list();

  // 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 list 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";
import { BadRequest } from "pushpress/models/errors/badrequest.js";
import { InternalServerError } from "pushpress/models/errors/internalservererror.js";
import { NotFound } from "pushpress/models/errors/notfound.js";
import { RateLimited } from "pushpress/models/errors/ratelimited.js";
import { SDKValidationError } from "pushpress/models/errors/sdkvalidationerror.js";
import { Timeout } from "pushpress/models/errors/timeout.js";
import { Unauthorized } from "pushpress/models/errors/unauthorized.js";

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

async function run() {
  let result;
  try {
    result = await pushpress.apps.list();

    // 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
`prod`	`https://api.pushpress.com`
`stage`	`https://api.pushpressstage.com`
`dev`	`https://api.pushpressdev.com`

Example

import { Pushpress } from "pushpress";

const pushpress = new Pushpress({
  server: "dev",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushpress.apps.list();

  // 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";

const pushpress = new Pushpress({
  serverURL: "https://api.pushpress.com",
  apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});

async function run() {
  const result = await pushpress.apps.list();

  // 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";
import { HTTPClient } from "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";

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

async function run() {
  const result = await pushpress.apps.list();

  // 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";

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

You can also enable a default debug logger by setting an environment variable PUSHPRESS_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.

Files

README.md

Latest commit

History

README.md

File metadata and controls

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

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy