README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/formancehq/numary-sdk-php.git"
    }
  ],
  "require": {
    "formancehq/numary-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new Numary\Ledger\Api\AccountsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$ledger = ledger001; // string | Name of the ledger.
$address = users:001; // string | Exact address of the account. It must match the following regular expressions pattern: ``` ^\\w+(:\\w+)*$ ```
$request_body = NULL; // array<string,mixed> | metadata

try {
    $apiInstance->addMetadataToAccount($ledger, $address, $request_body);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->addMetadataToAccount: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AccountsApi	addMetadataToAccount	POST /{ledger}/accounts/{address}/metadata	Add metadata to an account
AccountsApi	countAccounts	HEAD /{ledger}/accounts	Count the accounts from a ledger
AccountsApi	getAccount	GET /{ledger}/accounts/{address}	Get account by its address
AccountsApi	listAccounts	GET /{ledger}/accounts	List accounts from a ledger
BalancesApi	getBalances	GET /{ledger}/balances	Get the balances from a ledger's account
BalancesApi	getBalancesAggregated	GET /{ledger}/aggregate/balances	Get the aggregated balances from selected accounts
LedgerApi	getLedgerInfo	GET /{ledger}/_info	Get information about a ledger
LogsApi	listLogs	GET /{ledger}/logs	List the logs from a ledger
MappingApi	getMapping	GET /{ledger}/mapping	Get the mapping of a ledger
MappingApi	updateMapping	PUT /{ledger}/mapping	Update the mapping of a ledger
ScriptApi	runScript	POST /{ledger}/script	Execute a Numscript
ServerApi	getInfo	GET /_info	Show server information
StatsApi	readStats	GET /{ledger}/stats	Get statistics from a ledger
TransactionsApi	addMetadataOnTransaction	POST /{ledger}/transactions/{txid}/metadata	Set the metadata of a transaction by its ID
TransactionsApi	countTransactions	HEAD /{ledger}/transactions	Count the transactions from a ledger
TransactionsApi	createTransaction	POST /{ledger}/transactions	Create a new transaction to a ledger
TransactionsApi	createTransactions	POST /{ledger}/transactions/batch	Create a new batch of transactions to a ledger
TransactionsApi	getTransaction	GET /{ledger}/transactions/{txid}	Get transaction from a ledger by its ID
TransactionsApi	listTransactions	GET /{ledger}/transactions	List transactions from a ledger
TransactionsApi	revertTransaction	POST /{ledger}/transactions/{txid}/revert	Revert a ledger transaction by its ID

Models

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: v1.9.3
Build package: org.openapitools.codegen.languages.PhpClientCodegen

numary / numary-sdk-php

Maintainers

Details