LavaPayments

Introduction

LavaPayments is a JavaScript library designed to interact with the Lava API, facilitating the management of products, sales, and invoices. This library provides a simple interface to perform various operations such as retrieving products, sales data, and creating invoices.

Table of Contents

• Introduction
• Installation
• Usage
  • Initialization
  • Methods
• Features
• Dependencies
• Configuration
• Examples
• Troubleshooting
• Contributors
• License

Installation

To install LavaPayments, you need to have Node.js installed. You can then use npm or yarn to install the package.

npm install lavapayments

or

yarn add lavapayments

Usage

Initialization

To start using LavaPayments, you need to create an instance of the LavaPayments class by providing your API key.

import LavaPayments from 'lavapayments'

const lavaPayments = new LavaPayments('your-api-key')

Methods

getProducts()

Retrieves a list of products.

const products = await lavaPayments.getProducts()
console.log(products)

or

lavaPayments
    .getProducts()
    .then((products) => {
        console.log(products)
    })
    .catch((error) => {
        console.error(error)
    })

getSales()

Retrieves a list of sales.

lavaPayments
    .getSales()
    .then((sales) => {
        console.log(sales)
    })
    .catch((error) => {
        console.error(error)
    })

getProductSales(uuid)

Retrieves sales information for a specific product using its UUID.

lavaPayments
    .getProductSales('product-uuid')
    .then((sales) => {
        console.log(sales)
    })
    .catch((error) => {
        console.error(error)
    })

getInvoice(id)

Retrieves an invoice by its ID.

lavaPayments
    .getInvoice('invoice-id')
    .then((invoice) => {
        console.log(invoice)
    })
    .catch((error) => {
        console.error(error)
    })

createInvoice({ email, offerId, currency, buyerLanguage })

Creates a new invoice. All fields are required.

const invoiceData = {
    email: '[email protected]',
    offerId: 'offer-id',
    currency: 'USD',
    buyerLanguage: 'en',
}

lavaPayments
    .createInvoice(invoiceData)
    .then((invoice) => {
        console.log(invoice)
    })
    .catch((error) => {
        console.error(error)
    })

Features

• Retrieve product information.
• Retrieve sales information.
• Retrieve specific product sales.
• Retrieve invoice details.
• Create new invoices.

Dependencies

• node-fetch: Used to make HTTP requests.

Configuration

You need to configure the LavaPayments instance with your API key to authenticate your requests.

Examples

See the Usage section for examples on how to use each method provided by LavaPayments.

Troubleshooting

If you encounter issues, ensure that:

• Your API key is correct and active.
• The Lava API endpoint is reachable.
• Required parameters are provided for each method.

Contributors

• https://github.com/merkuluf

License

This project is licensed under the MIT License. See the LICENSE file for details.