MappingApi.md

ledger.MappingApi

All URIs are relative to http://localhost

Method	HTTP request	Description
getMapping	GET /{ledger}/mapping	Get the mapping of a ledger
updateMapping	PUT /{ledger}/mapping	Update the mapping of a ledger

getMapping

MappingResponse getMapping()

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.MappingApi(configuration);

let body:ledger.MappingApiGetMappingRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
};

apiInstance.getMapping(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
ledger	[string]	Name of the ledger.	defaults to undefined

Return type

MappingResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateMapping

MappingResponse updateMapping(mapping)

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.MappingApi(configuration);

let body:ledger.MappingApiUpdateMappingRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
  // Mapping
  mapping: {
    contracts: [
      {
        account: "users:001",
        expr: {},
      },
    ],
  },
};

apiInstance.updateMapping(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
mapping	Mapping
ledger	[string]	Name of the ledger.	defaults to undefined

Return type

MappingResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json; charset=utf-8
• Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]