# Packages

test

No description provided by the author

Go API client for ledgerclient

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

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

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

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import ledgerclient "github.com/formancehq/numary-sdk-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ledgerclient.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), ledgerclient.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), ledgerclient.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), ledgerclient.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for 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

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime