beyond-pci-typescript

Developer-friendly, idiomatic Typescript SDK for the beyond-pci-typescript API.

Summary

Beyond PCI API: PCI scanning and compliance API for tenants

Table of Contents

• @beyond-pci/sdk
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

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

NPM

npm add @beyond-pci/sdk

PNPM

pnpm add @beyond-pci/sdk

Bun

bun add @beyond-pci/sdk

Yarn

yarn add @beyond-pci/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 { BeyondPCI } from "@beyond-pci/sdk";

const beyondPCI = new BeyondPCI({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await beyondPCI.merchants.list({});

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------ | ---- | ----------- | | bearerAuth | http | HTTP Bearer |

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:

import { BeyondPCI } from "@beyond-pci/sdk";

const beyondPCI = new BeyondPCI({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await beyondPCI.merchants.list({});

  console.log(result);
}

run();

Available Resources and Operations

assetConfigs

• list - List asset configs
• create - Add asset config
• delete - Remove asset config

merchants

• list - List all merchants
• get - Get merchant details
• update - Update merchant
• register - Register a new merchant
• getRegistration - Get merchant registration status
• activate - Activate merchant
• cancel - Cancel merchant
• getCompliance - Get merchant compliance status

saq

• downloadPdf - Download SAQ PDF
• generateLink - Generate SAQ access link

scans

• list - List all scans
• get - Get scan details
• getReport - Download scan report
• listByMerchant - List scans for merchant
• trigger - Trigger on-demand scan
• getNext - Get next scheduled scan
• cancel - Cancel running scan

webhooks

• list - List webhooks
• create - Create webhook
• update - Update webhook
• delete - Delete webhook
• test - Send test 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.

• assetConfigsCreate - Add asset config
• assetConfigsDelete - Remove asset config
• assetConfigsList - List asset configs
• merchantsActivate - Activate merchant
• merchantsCancel - Cancel merchant
• merchantsGet - Get merchant details
• merchantsGetCompliance - Get merchant compliance status
• merchantsGetRegistration - Get merchant registration status
• merchantsList - List all merchants
• merchantsRegister - Register a new merchant
• merchantsUpdate - Update merchant
• saqDownloadPdf - Download SAQ PDF
• saqGenerateLink - Generate SAQ access link
• scansCancel - Cancel running scan
• scansGet - Get scan details
• scansGetNext - Get next scheduled scan
• scansGetReport - Download scan report
• scansList - List all scans
• scansListByMerchant - List scans for merchant
• scansTrigger - Trigger on-demand scan
• webhooksCreate - Create webhook
• webhooksDelete - Delete webhook
• webhooksList - List webhooks
• webhooksTest - Send test webhook
• webhooksUpdate - Update webhook

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 { BeyondPCI } from "@beyond-pci/sdk";

const beyondPCI = new BeyondPCI({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await beyondPCI.merchants.list({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  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 { BeyondPCI } from "@beyond-pci/sdk";

const beyondPCI = new BeyondPCI({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await beyondPCI.merchants.list({});

  console.log(result);
}

run();

Error Handling

BeyondPciError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { BeyondPCI } from "@beyond-pci/sdk";
import * as errors from "@beyond-pci/sdk/models/errors";

const beyondPCI = new BeyondPCI({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  try {
    const result = await beyondPCI.merchants.list({});

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.BeyondPciError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ListMerchantsResponseBody) {
        console.log(error.data$.error); // errors.ErrorT
      }
    }
  }
}

run();

Error Classes

Primary error:

• BeyondPciError: The base class for HTTP error responses.

Network errors:

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

Inherit from BeyondPciError:

• UpdateMerchantResponseBody: Default Response. Status code 400. Applicable to 1 of 25 methods.*
• RegisterMerchantResponseBody: Default Response. Status code 400. Applicable to 1 of 25 methods.*
• GenerateSaqLinkResponseBody: Default Response. Status code 400. Applicable to 1 of 25 methods.*
• CreateAssetConfigResponseBody: Default Response. Status code 400. Applicable to 1 of 25 methods.*
• TriggerScanResponseBody: Default Response. Status code 400. Applicable to 1 of 25 methods.*
• CreateWebhookResponseBody: Default Response. Status code 400. Applicable to 1 of 25 methods.*
• UpdateWebhookResponseBody: Default Response. Status code 400. Applicable to 1 of 25 methods.*
• ListMerchantsResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• GetMerchantResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• UpdateMerchantMerchantsResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• RegisterMerchantMerchantsResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• GetMerchantRegistrationResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• ActivateMerchantResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• CancelMerchantResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• GetMerchantComplianceResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• DownloadSaqPdfResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• GenerateSAQLinkSAQResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• ListAssetConfigsResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• CreateAssetConfigAssetConfigsResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• DeleteAssetConfigResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• ListScansResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• GetScanResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• ListMerchantScansResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• TriggerScanScansResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• GetNextScanResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• CancelScanResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• ListWebhooksResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• CreateWebhookWebhooksResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• UpdateWebhookWebhooksResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• DeleteWebhookResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• TestWebhookResponseBody: Default Response. Status code 401. Applicable to 1 of 25 methods.*
• GetMerchantMerchantsResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• UpdateMerchantMerchantsResponseResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• GetMerchantRegistrationMerchantsResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• ActivateMerchantMerchantsResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• CancelMerchantMerchantsResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• GetMerchantComplianceMerchantsResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• DownloadSAQPdfSAQResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• ListAssetConfigsAssetConfigsResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• DeleteAssetConfigAssetConfigsResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• ListScansScansResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• GetScanScansResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• GetScanReportResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• ListMerchantScansScansResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• TriggerScanScansResponseResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• GetNextScanScansResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• CancelScanScansResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• ListWebhooksWebhooksResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• UpdateWebhookWebhooksResponseResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• DeleteWebhookWebhooksResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• TestWebhookWebhooksResponseBody: Default Response. Status code 404. Applicable to 1 of 25 methods.*
• ActivateMerchantMerchantsResponseResponseBody: Default Response. Status code 409. Applicable to 1 of 25 methods.*
• CancelMerchantMerchantsResponseResponseBody: Default Response. Status code 409. Applicable to 1 of 25 methods.*
• TriggerScanScansResponse409ResponseBody: Default Response. Status code 409. Applicable to 1 of 25 methods.*
• TestWebhookWebhooksResponseResponseBody: Default Response. Status code 409. Applicable to 1 of 25 methods.*
• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number 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 indexes associated with the available servers:

| # | Server | Description | | --- | ----------------------------------- | ----------- | | 0 | https://staging.api.beyondpci.com | Staging | | 1 | https://api.beyondpci.com | Production |

Example

import { BeyondPCI } from "@beyond-pci/sdk";

const beyondPCI = new BeyondPCI({
  serverIdx: 1,
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await beyondPCI.merchants.list({});

  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 { BeyondPCI } from "@beyond-pci/sdk";

const beyondPCI = new BeyondPCI({
  serverURL: "https://api.beyondpci.com",
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await beyondPCI.merchants.list({});

  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 { BeyondPCI } from "@beyond-pci/sdk";
import { HTTPClient } from "@beyond-pci/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 BeyondPCI({ httpClient });

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 { BeyondPCI } from "@beyond-pci/sdk";

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

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.

SDK Created by Scalar