Skip to content

Latest commit

 

History

History
executable file
·
329 lines (255 loc) · 15.4 KB

README.md

File metadata and controls

executable file
·
329 lines (255 loc) · 15.4 KB
Raw

transactions

Available Operations

addMetadataOnTransaction

Set the metadata of a transaction by its ID

Example Usage

import { Formance } from "@speakeasy-sdks/formance";
import { AddMetadataOnTransactionResponse } from "@speakeasy-sdks/formance/dist/sdk/models/operations";
import { ErrorsEnum } from "@speakeasy-sdks/formance/dist/sdk/models/shared";

const sdk = new Formance({
  security: {
    authorization: "",
  },
});

sdk.transactions.addMetadataOnTransaction({
  idempotencyKey: "facilis",
  requestBody: {
    "architecto": "architecto",
    "repudiandae": "ullam",
  },
  async: true,
  dryRun: true,
  ledger: "ledger001",
  txid: 1234,
}).then((res: AddMetadataOnTransactionResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.AddMetadataOnTransactionRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.AddMetadataOnTransactionResponse>

countTransactions

Count the transactions from a ledger

Example Usage

import { Formance } from "@speakeasy-sdks/formance";
import { CountTransactionsResponse } from "@speakeasy-sdks/formance/dist/sdk/models/operations";
import { ErrorsEnum } from "@speakeasy-sdks/formance/dist/sdk/models/shared";

const sdk = new Formance({
  security: {
    authorization: "",
  },
});

sdk.transactions.countTransactions({
  account: "users:001",
  destination: "users:001",
  endTime: new Date("2022-01-23T10:45:15.714Z"),
  ledger: "ledger001",
  metadata: {
    "quibusdam": "sed",
    "saepe": "pariatur",
    "accusantium": "consequuntur",
    "praesentium": "natus",
  },
  reference: "ref:001",
  source: "users:001",
  startTime: new Date("2022-11-16T19:20:12.159Z"),
}).then((res: CountTransactionsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.CountTransactionsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.CountTransactionsResponse>

createTransaction

Create a new transaction to a ledger

Example Usage

import { Formance } from "@speakeasy-sdks/formance";
import { CreateTransactionResponse } from "@speakeasy-sdks/formance/dist/sdk/models/operations";
import { ErrorsEnum } from "@speakeasy-sdks/formance/dist/sdk/models/shared";

const sdk = new Formance({
  security: {
    authorization: "",
  },
});

sdk.transactions.createTransaction({
  idempotencyKey: "quo",
  postTransaction: {
    metadata: {
      "pariatur": "maxime",
      "ea": "excepturi",
      "odit": "ea",
      "accusantium": "ab",
    },
    postings: [
      {
        amount: 100,
        asset: "COIN",
        destination: "users:002",
        source: "users:001",
      },
      {
        amount: 100,
        asset: "COIN",
        destination: "users:002",
        source: "users:001",
      },
      {
        amount: 100,
        asset: "COIN",
        destination: "users:002",
        source: "users:001",
      },
      {
        amount: 100,
        asset: "COIN",
        destination: "users:002",
        source: "users:001",
      },
    ],
    reference: "ref:001",
    script: {
      plain: "vars {
    account $user
    }
    send [COIN 10] (
    	source = @world
    	destination = $user
    )
    ",
      vars: {},
    },
    timestamp: new Date("2022-04-03T11:56:45.015Z"),
  },
  async: true,
  dryRun: true,
  ledger: "ledger001",
}).then((res: CreateTransactionResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.CreateTransactionRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.CreateTransactionResponse>

getTransaction

Get transaction from a ledger by its ID

Example Usage

import { Formance } from "@speakeasy-sdks/formance";
import { GetTransactionResponse } from "@speakeasy-sdks/formance/dist/sdk/models/operations";
import { ErrorsEnum } from "@speakeasy-sdks/formance/dist/sdk/models/shared";

const sdk = new Formance({
  security: {
    authorization: "",
  },
});

sdk.transactions.getTransaction({
  ledger: "ledger001",
  txid: 1234,
}).then((res: GetTransactionResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.GetTransactionRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetTransactionResponse>

listTransactions

List transactions from a ledger, sorted by txid in descending order.

Example Usage

import { Formance } from "@speakeasy-sdks/formance";
import { ListTransactionsResponse } from "@speakeasy-sdks/formance/dist/sdk/models/operations";
import { ErrorsEnum } from "@speakeasy-sdks/formance/dist/sdk/models/shared";

const sdk = new Formance({
  security: {
    authorization: "",
  },
});

sdk.transactions.listTransactions({
  account: "users:001",
  cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
  destination: "users:001",
  endTime: new Date("2022-07-31T16:08:22.625Z"),
  ledger: "ledger001",
  metadata: {
    "eaque": "pariatur",
    "nemo": "voluptatibus",
    "perferendis": "fugiat",
  },
  pageSize: 230742,
  reference: "ref:001",
  source: "users:001",
  startTime: new Date("2022-03-27T19:22:24.458Z"),
}).then((res: ListTransactionsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.ListTransactionsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.ListTransactionsResponse>

revertTransaction

Revert a ledger transaction by its ID

Example Usage

import { Formance } from "@speakeasy-sdks/formance";
import { RevertTransactionResponse } from "@speakeasy-sdks/formance/dist/sdk/models/operations";
import { ErrorsEnum } from "@speakeasy-sdks/formance/dist/sdk/models/shared";

const sdk = new Formance({
  security: {
    authorization: "",
  },
});

sdk.transactions.revertTransaction({
  ledger: "ledger001",
  txid: 1234,
}).then((res: RevertTransactionResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.RevertTransactionRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.RevertTransactionResponse>