4.2.1 • Published 7 months ago

@formance/formance-sdk v4.2.1

Weekly downloads
-
License
-
Repository
github
Last release
7 months ago

@formance/formance-sdk

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

Summary

Formance Stack API: Open, modular foundation for unique payments flows

Introduction

This API is documented in OpenAPI format.

Authentication

Formance Stack offers one forms of authentication:

  • OAuth2 OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.

Table of Contents

SDK Installation

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

NPM

npm add @formance/formance-sdk

PNPM

pnpm add @formance/formance-sdk

Bun

bun add @formance/formance-sdk

Yarn

yarn add @formance/formance-sdk 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 { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
  security: {
    clientID: "<YOUR_CLIENT_ID_HERE>",
    clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
  },
});

async function run() {
  const result = await sdk.getVersions();

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

run();

Available Resources and Operations

auth

auth.v1

ledger

ledger.v1

ledger.v2

orchestration

orchestration.v1

orchestration.v2

payments

payments.v1

payments.v3

reconciliation

reconciliation.v1

SDK

search

search.v1

wallets

wallets.v1

webhooks

webhooks.v1

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the sdk/models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the addMetadataOnTransaction method may throw the following errors:

Error TypeStatus CodeContent Type
errors.V2ErrorResponsedefaultapplication/json
errors.SDKError4XX, 5XX*/*

If the method throws an error and it is not captured by the known errors, it will default to throwing a SDKError.

import { SDK } from "@formance/formance-sdk";
import {
  SDKValidationError,
  V2ErrorResponse,
} from "@formance/formance-sdk/sdk/models/errors";

const sdk = new SDK({
  security: {
    clientID: "<YOUR_CLIENT_ID_HERE>",
    clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
  },
});

async function run() {
  let result;
  try {
    result = await sdk.ledger.v2.addMetadataOnTransaction({
      requestBody: {
        "admin": "true",
      },
      dryRun: true,
      id: BigInt("1234"),
      ledger: "ledger001",
    });

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof V2ErrorResponse): {
        // Handle err.data$: V2ErrorResponseData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        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 multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the sdk/models/errors/httpclienterrors.ts module:

HTTP Client ErrorDescription
RequestAbortedErrorHTTP request was aborted by the client
RequestTimeoutErrorHTTP request timed out due to an AbortSignal signal
ConnectionErrorHTTP client was unable to make a request to a server
InvalidRequestErrorAny input used to create a request is invalid
UnexpectedClientErrorUnrecognised or unexpected error

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:

#ServerVariablesDescription
0http://localhostlocal server
1https://{organization}.{environment}.formance.cloudenvironmentorganizationA per-organization and per-environment API

If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:

VariableParameterSupported ValuesDefaultDescription
environmentenvironment: models.ServerEnvironment- "eu.sandbox"- "sandbox"- "eu-west-1"- "us-east-1""eu.sandbox"The environment name. Defaults to the production environment.
organizationorganization: stringstring"orgID-stackID"The organization name. Defaults to a generic organization.

Example

import { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
  serverIdx: 1,
  environment: "us-east-1",
  organization: "<value>",
  security: {
    clientID: "<YOUR_CLIENT_ID_HERE>",
    clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
  },
});

async function run() {
  const result = await sdk.getVersions();

  // 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 { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
  serverURL: "http://localhost",
  security: {
    clientID: "<YOUR_CLIENT_ID_HERE>",
    clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
  },
});

async function run() {
  const result = await sdk.getVersions();

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

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

NameTypeScheme
clientIDclientSecretoauth2OAuth2 Client Credentials Flow

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
  security: {
    clientID: "<YOUR_CLIENT_ID_HERE>",
    clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
  },
});

async function run() {
  const result = await sdk.getVersions();

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

run();

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.

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

!TIP

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { SDK } from "@formance/formance-sdk";
import { openAsBlob } from "node:fs";

const sdk = new SDK({
  security: {
    clientID: "<YOUR_CLIENT_ID_HERE>",
    clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
  },
});

async function run() {
  const result = await sdk.ledger.v2.importLogs({
    v2ImportLogsRequest: await openAsBlob("example.file"),
    ledger: "ledger001",
  });

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

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 { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
  security: {
    clientID: "<YOUR_CLIENT_ID_HERE>",
    clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
  },
});

async function run() {
  const result = await sdk.getVersions({
    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 { SDK } from "@formance/formance-sdk";

const sdk = new SDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    clientID: "<YOUR_CLIENT_ID_HERE>",
    clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
  },
});

async function run() {
  const result = await sdk.getVersions();

  // 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 { SDK } from "@formance/formance-sdk";

const sdk = new SDK({ 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!

SDK Created by Speakeasy

@everything-registry/sub-chunk-337
4.0.0

9 months ago

4.2.1

7 months ago

4.2.0

8 months ago

3.3.0

11 months ago

4.1.0

8 months ago

3.2.0

12 months ago

3.1.1

1 year ago

3.0.0

1 year ago

3.1.0

1 year ago

2.7.0

1 year ago

2.4.1

1 year ago

2.4.3

1 year ago

2.6.0

1 year ago

2.4.2

1 year ago

2.4.4

1 year ago

2.5.0

1 year ago

2.5.1

1 year ago

2.4.0

1 year ago

2.3.2

1 year ago

2.3.3

1 year ago

2.3.1

1 year ago

2.3.0

2 years ago

2.2.1

2 years ago

2.2.0

2 years ago

2.1.3

2 years ago

2.1.2

2 years ago

2.1.1

2 years ago

2.0.0-rc.15

2 years ago

2.0.0-rc.14

2 years ago

2.0.0-rc.13

2 years ago

2.0.0-rc.12

2 years ago

2.0.0-rc.11

2 years ago

2.0.0-rc.10

2 years ago

2.0.0-rc.8

2 years ago

2.0.0-rc.9

2 years ago

2.0.0-rc.7

2 years ago

2.0.0-rc.4

2 years ago

2.0.0-rc.3

2 years ago

2.0.0-rc.2

2 years ago

2.0.0-rc.1

2 years ago

2.0.0-beta.15

2 years ago

2.0.0-beta.16

2 years ago

2.0.0-beta.14

2 years ago

2.0.0-beta.13

2 years ago

2.0.0-beta.12

2 years ago

2.0.0-beta.11

2 years ago

2.0.0-beta.10

2 years ago

2.0.0-beta.9

2 years ago

2.0.0-beta.8

2 years ago

2.0.0-beta.6

2 years ago

2.0.0-beta.5

2 years ago

2.0.0-beta.2

2 years ago

1.0.202307124

2 years ago

1.0.2023071-8.1

2 years ago

1.0.20230718

2 years ago

1.0.20230710

2 years ago

1.0.20230724

2 years ago

1.0.20230713

2 years ago

1.0.20230725

2 years ago

1.0.20230714

2 years ago

1.0.20230627

2 years ago

1.0.20230915

2 years ago

1.0.20230623-beta.1

2 years ago