Bolt-Typescript-SDK

Summary

Bolt API Reference: A comprehensive Bolt API reference for interacting with Accounts, Payments, Orders and more.

SDK Installation

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

NPM

npm add @boltpay/bolt-typescript-sdk

PNPM

pnpm add @boltpay/bolt-typescript-sdk

Bun

bun add @boltpay/bolt-typescript-sdk

Yarn

yarn add @boltpay/bolt-typescript-sdk zod

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

SDK Example Usage

Example

import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";

const boltTypescriptSDK = new BoltTypescriptSDK({
  security: {
    oauth: "<YOUR_OAUTH_HERE>",
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await boltTypescriptSDK.account.getDetails(
    "<value>",
    "<value>",
  );

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

run();

Available Resources and Operations

Available methods

account

getDetails - Retrieve account details
addAddress - Add an address
updateAddress - Edit an existing address
deleteAddress - Delete an existing address
addPaymentMethod - Add a payment method
deletePaymentMethod - Delete an existing payment method

orders

ordersCreate - Create an order that was prepared outside the Bolt ecosystem.

payments

payments.guest

initialize - Initialize a Bolt payment for guest shoppers
performAction - Finalize a pending guest payment

payments.loggedIn

initialize - Initialize a Bolt payment for logged in shoppers
performAction - Finalize a pending payment

testing

createAccount - Create a test account
testingAccountPhoneGet - Get a random phone number
getCreditCard - Retrieve a tokenized test credit card

Error Handling

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

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 getDetails method may throw the following errors:

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.FieldError	4XX	application/json
errors.SDKError	5XX	/

import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import {
  ErrorT,
  FieldError,
  SDKValidationError,
} from "@boltpay/bolt-typescript-sdk/models/errors";

const boltTypescriptSDK = new BoltTypescriptSDK({
  security: {
    oauth: "<YOUR_OAUTH_HERE>",
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  let result;
  try {
    result = await boltTypescriptSDK.account.getDetails("<value>", "<value>");

    // 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 ErrorT): {
        // Handle err.data$: ErrorTData
        return;
      }
      case (err instanceof FieldError): {
        // Handle err.data$: FieldErrorData
        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

Server Variables

The default server https://{environment}.bolt.com/v3 contains variables and is set to https://api-sandbox.bolt.com/v3 by default. To override default values, the following parameters are available when initializing the SDK client instance:

environment: models.ServerEnvironment

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 { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";

const boltTypescriptSDK = new BoltTypescriptSDK({
  serverURL: "https://api-sandbox.bolt.com/v3",
  security: {
    oauth: "<YOUR_OAUTH_HERE>",
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await boltTypescriptSDK.account.getDetails(
    "<value>",
    "<value>",
  );

  // 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 { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { HTTPClient } from "@boltpay/bolt-typescript-sdk/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 BoltTypescriptSDK({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name	Type	Scheme
`oauth`	oauth2	OAuth2 token
`apiKey`	apiKey	API key

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";

const boltTypescriptSDK = new BoltTypescriptSDK({
  security: {
    oauth: "<YOUR_OAUTH_HERE>",
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await boltTypescriptSDK.account.getDetails(
    "<value>",
    "<value>",
  );

  // 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 { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import {
  AddressReferenceExplicitTag,
  CountryCode,
  CreditCardNetwork,
  Currency,
  DotTag,
} from "@boltpay/bolt-typescript-sdk/models/components";

const boltTypescriptSDK = new BoltTypescriptSDK();

async function run() {
  const result = await boltTypescriptSDK.payments.guest.initialize(
    {
      apiKey: "<YOUR_API_KEY_HERE>",
    },
    {
      profile: {
        createAccount: true,
        firstName: "Alice",
        lastName: "Baker",
        email: "alice@example.com",
        phone: "+14155550199",
      },
      cart: {
        orderReference: "order_100",
        orderDescription: "Order #1234567890",
        displayId: "215614191",
        shipments: [
          {
            address: {
              dotTag: AddressReferenceExplicitTag.Explicit,
              firstName: "Alice",
              lastName: "Baker",
              streetAddress1: "535 Mission St, Ste 1401",
              locality: "San Francisco",
              postalCode: "94105",
              region: "CA",
              countryCode: CountryCode.Us,
            },
            cost: {
              currency: Currency.Usd,
              units: 10000,
            },
            carrier: "FedEx",
          },
        ],
        discounts: [
          {
            amount: {
              currency: Currency.Usd,
              units: 10000,
            },
            code: "SUMMER10DISCOUNT",
            detailsUrl: "https://www.example.com/SUMMER-SALE",
          },
        ],
        items: [
          {
            name: "Bolt Swag Bag",
            reference: "item_100",
            description: "Large tote with Bolt logo.",
            totalAmount: {
              currency: Currency.Usd,
              units: 9000,
            },
            unitPrice: 1000,
            quantity: 9,
            imageUrl: "https://www.example.com/products/123456/images/1.png",
          },
        ],
        total: {
          currency: Currency.Usd,
          units: 9000,
        },
        tax: {
          currency: Currency.Usd,
          units: 100,
        },
      },
      paymentMethod: {
        dotTag: DotTag.CreditCard,
        billingAddress: {
          dotTag: AddressReferenceExplicitTag.Explicit,
          firstName: "Alice",
          lastName: "Baker",
          company: "ACME Corporation",
          streetAddress1: "535 Mission St, Ste 1401",
          streetAddress2: "c/o Shipping Department",
          locality: "San Francisco",
          postalCode: "94105",
          region: "CA",
          countryCode: CountryCode.Us,
          email: "alice@example.com",
          phone: "+14155550199",
        },
        network: CreditCardNetwork.Visa,
        bin: "411111",
        last4: "1004",
        expiration: "2025-03",
        token: "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0",
      },
    },
    "<value>",
    "<value>",
  );

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

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

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

accountAddAddress - Add an address
accountAddPaymentMethod - Add a payment method
accountDeleteAddress - Delete an existing address
accountDeletePaymentMethod - Delete an existing payment method
accountGetDetails - Retrieve account details
accountUpdateAddress - Edit an existing address
oAuthGetToken - Get OAuth token
ordersOrdersCreate - Create an order that was prepared outside the Bolt ecosystem.
paymentsGuestInitialize - Initialize a Bolt payment for guest shoppers
paymentsGuestPerformAction - Finalize a pending guest payment
paymentsLoggedInInitialize - Initialize a Bolt payment for logged in shoppers
paymentsLoggedInPerformAction - Finalize a pending payment
testingCreateAccount - Create a test account
testingGetCreditCard - Retrieve a tokenized test credit card
testingTestingAccountPhoneGet - Get a random phone number

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 { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";

const boltTypescriptSDK = new BoltTypescriptSDK({
  security: {
    oauth: "<YOUR_OAUTH_HERE>",
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await boltTypescriptSDK.account.getDetails(
    "<value>",
    "<value>",
    {
      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 { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";

const boltTypescriptSDK = new BoltTypescriptSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    oauth: "<YOUR_OAUTH_HERE>",
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await boltTypescriptSDK.account.getDetails(
    "<value>",
    "<value>",
  );

  // 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 { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";

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

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Bolt-Typescript-SDK

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

SDK Example Usage

Example

Available Resources and Operations

account

oAuth

orders

payments

payments.guest

payments.loggedIn

testing

Error Handling

Server Selection

Server Variables

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Per-Operation Security Schemes

Requirements

Standalone functions

Retries

Debugging

Development

Maturity

Contributions

Files

README.md

Latest commit

History

README.md

File metadata and controls

Bolt-Typescript-SDK

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

SDK Example Usage

Example

Available Resources and Operations

account

oAuth

orders

payments

payments.guest

payments.loggedIn

testing

Error Handling

Server Selection

Server Variables

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Per-Operation Security Schemes

Requirements

Standalone functions

Retries

Debugging

Development

Maturity

Contributions