Beach Depository TypeScript Library

The Beach Depository TypeScript library provides convenient access to the Beach Depository API from TypeScript.

Table of Contents

• Installation
• Reference
• Usage
• Environments
• Request and Response Types
• Exception Handling
• Advanced
  • Subpackage Exports
  • Additional Headers
  • Additional Query String Parameters
  • Retries
  • Timeouts
  • Aborting Requests
  • Access Raw Response Data
  • Logging
  • Custom Fetch
  • Runtime Compatibility
• Contributing

Installation

npm i -s @beach-depository/sdk

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

import { BeachApiClient } from "@beach-depository/sdk";

const client = new BeachApiClient({ token: "YOUR_TOKEN" });
await client.fboAccounts.create({
    firstName: "firstName",
    lastName: "lastName",
    email: "email",
    phone: "phone"
});

Environments

This SDK allows you to configure different environments for API requests.

import { BeachApiClient, BeachApiEnvironment } from "@beach-depository/sdk";

const client = new BeachApiClient({
    environment: BeachApiEnvironment.Sandbox,
});

Request and Response Types

The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace:

import { BeachApi } from "@beach-depository/sdk";

const request: BeachApi.ListFboAccountsRequest = {
    ...
};

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

import { BeachApiError } from "@beach-depository/sdk";

try {
    await client.fboAccounts.create(...);
} catch (err) {
    if (err instanceof BeachApiError) {
        console.log(err.statusCode);
        console.log(err.message);
        console.log(err.body);
        console.log(err.rawResponse);
    }
}

Advanced

Subpackage Exports

This SDK supports direct imports of subpackage clients, which allows JavaScript bundlers to tree-shake and include only the imported subpackage code. This results in much smaller bundle sizes.

import { OrganizationClient } from '@beach-depository/sdk/organization';

const client = new OrganizationClient({...});

Additional Headers

If you would like to send additional headers as part of the request, use the headers request option.

import { BeachApiClient } from "@beach-depository/sdk";

const client = new BeachApiClient({
    ...
    headers: {
        'X-Custom-Header': 'custom value'
    }
});

const response = await client.fboAccounts.create(..., {
    headers: {
        'X-Custom-Header': 'custom value'
    }
});

Additional Query String Parameters

If you would like to send additional query string parameters as part of the request, use the queryParams request option.

const response = await client.fboAccounts.create(..., {
    queryParams: {
        'customQueryParamKey': 'custom query param value'
    }
});

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (All server errors, including 500)

recommended: retries on

• 408 (Timeout)
• 429 (Too Many Requests)
• 502 (Bad Gateway)
• 503 (Service Unavailable)
• 504 (Gateway Timeout)

Use the maxRetries request option to configure this behavior.

const response = await client.fboAccounts.create(..., {
    maxRetries: 0 // override maxRetries at the request level
});

Timeouts

The SDK defaults to a 60 second timeout. Use the timeoutInSeconds option to configure this behavior.

const response = await client.fboAccounts.create(..., {
    timeoutInSeconds: 30 // override timeout to 30s
});

Aborting Requests

The SDK allows users to abort requests at any point by passing in an abort signal.

const controller = new AbortController();
const response = await client.fboAccounts.create(..., {
    abortSignal: controller.signal
});
controller.abort(); // aborts the request

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .withRawResponse() method. The .withRawResponse() method returns a promise that results to an object with a data and a rawResponse property.

const { data, rawResponse } = await client.fboAccounts.create(...).withRawResponse();

console.log(data);
console.log(rawResponse.headers['X-My-Header']);

Logging

The SDK supports logging. You can configure the logger by passing in a logging object to the client options.

import { BeachApiClient, logging } from "@beach-depository/sdk";

const client = new BeachApiClient({
    ...
    logging: {
        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
        silent: false, // defaults to true, set to false to enable logging
    }
});

The logging object can have the following properties:

• level: The log level to use. Defaults to logging.LogLevel.Info.
• logger: The logger to use. Defaults to a logging.ConsoleLogger.
• silent: Whether to silence the logger. Defaults to true.

The level property can be one of the following values:

• logging.LogLevel.Debug
• logging.LogLevel.Info
• logging.LogLevel.Warn
• logging.LogLevel.Error

To provide a custom logger, you can pass in an object that implements the logging.ILogger interface.

import winston from 'winston';

const winstonLogger = winston.createLogger({...});

const logger: logging.ILogger = {
    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
    info: (msg, ...args) => winstonLogger.info(msg, ...args),
    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
    error: (msg, ...args) => winstonLogger.error(msg, ...args),
};

import pino from 'pino';

const pinoLogger = pino({...});

const logger: logging.ILogger = {
  debug: (msg, ...args) => pinoLogger.debug(args, msg),
  info: (msg, ...args) => pinoLogger.info(args, msg),
  warn: (msg, ...args) => pinoLogger.warn(args, msg),
  error: (msg, ...args) => pinoLogger.error(args, msg),
};

Custom Fetch

The SDK provides a low-level fetch method for making custom HTTP requests while still benefiting from SDK-level configuration like authentication, retries, timeouts, and logging. This is useful for calling API endpoints not yet supported in the SDK.

const response = await client.fetch("/v1/custom/endpoint", {
    method: "GET",
}, {
    timeoutInSeconds: 30,
    maxRetries: 3,
    headers: {
        "X-Custom-Header": "custom-value",
    },
});

const data = await response.json();

Runtime Compatibility

The SDK works in the following runtimes:

• Node.js 18+
• Vercel
• Cloudflare Workers
• Deno v1.25+
• Bun 1.0+
• React Native

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!