@lnbits/client v0.10.10-rc1

@lnbits/client

LnbitsClient - JavaScript client for @lnbits/client API for LNbits, the free and open source bitcoin wallet and accounts system with plugins. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.10.9
• Package version: 0.10.9
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @lnbits/client --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @lnbits/client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var LnbitsClient = require('@lnbits/client');


var api = new LnbitsClient.CoreApi()
var usr = "usr_example"; // {String} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiDeleteSettingsAdminApiV1SettingsDelete(usr, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation for Models

• LnbitsClient.ConversionData
• LnbitsClient.CreateExtension
• LnbitsClient.CreateInvoiceData
• LnbitsClient.CreateLNURLData
• LnbitsClient.CreateLnurlAuth
• LnbitsClient.CreateTopup
• LnbitsClient.DecodePayment
• LnbitsClient.EditableSettings
• LnbitsClient.HTTPValidationError
• LnbitsClient.LocationInner
• LnbitsClient.Page
• LnbitsClient.Payment
• LnbitsClient.ValidationError

Documentation for Authorization

Authentication schemes defined for the API:

APIKeyHeader

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

APIKeyQuery

• Type: API key
• API key parameter name: api-key
• Location: URL query string