lago-javascript-client 0.20.0-beta → 0.22.0-beta

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Lago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,115 @@
+# Lago JavaScript Client
+
+This is a JavaScript wrapper for Lago API. Works in Cloudflare Workers, Deno, and Node.js. Generated from [the Lago Swagger document](https://swagger.getlago.com/#/).
+
+[![PyPI version](https://badge.fury.io/js/lago-javascript-client.svg)](https://badge.fury.io/js/lago-javascript-client)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html)
+
+## Installation
+
+For npm users:
+
+```bash
+npm install lago-javascript-client
+```
+
+```typescript
+// npm
+import { Client, getLagoError } from 'lago-javascript-client';
+
+// Deno
+import { Client, getLagoError } from 'https://deno.land/x/lago/mod.ts';
+
+const lagoClient = Client('__YOUR_API_KEY__');
+
+try {
+    const { data } = await lagoClient.billableMetrics.createBillableMetric(billableMetric);
+} catch (error) {
+    const lagoError = await getLagoError<typeof lagoClient.billableMetrics.createBillableMetric>(error);
+}
+```
+
+## Compatibility
+
+This SDK uses the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) and natively supported Node.js version >= 18. For other Node versions:
+
+1. Ideally, run Node with the [`--experimental-fetch` flag](https://nodejs.org/docs/latest-v16.x/api/cli.html#--experimental-fetch)
+
+1. Otherwise, polyfill the Fetch API by doing both:
+
+    1. [Patching globalThis](https://github.com/node-fetch/node-fetch#providing-global-access)
+
+    1. [Pass a Fetch instance](https://github.com/node-fetch/node-fetch#loading-and-configuring-the-module) to the Lago client
+
+        ```typescript
+        import { Client } from 'lago-javascript-client';
+        import fetch from 'node-fetch';
+
+        const lagoClient = Client("api_key", { customFetch: fetch });
+        ```
+
+## Usage
+
+Check the [Lago API reference](https://doc.getlago.com/docs/api/intro)
+
+### Error handling
+
+Use the get `getLagoError<>()` utility function to extract the error object and TypeScript type:
+
+```typescript
+try {
+    const { data } = await lagoClient.billableMetrics.createBillableMetric(billableMetric);
+} catch (error) {
+    const lagoError = await getLagoError<typeof lagoClient.billableMetrics.createBillableMetric>(error);
+}
+```
+
+## Development
+
+Uses [dnt](https://github.com/denoland/dnt) to build and test for Deno and Node.
+
+### Release new version
+
+Change the affected fields in `scripts/build_npm.ts` and commit to GitHub. GitHub Actions will build and deploy to npm.
+
+### Dependencies
+
+Requires [Deno](https://deno.land/) and [Node.js >= 18](https://nodejs.org/en/)
+
+### Generate client from Swagger
+
+```bash
+deno task generate:swagger
+```
+
+### Run tests
+
+```bash
+deno task test
+```
+
+### Build
+
+```bash
+deno task build
+```
+
+### Publish to npm
+
+```bash
+deno task build
+cd npm
+npm publish
+```
+
+## Documentation
+
+The Lago documentation is available at [doc.getlago.com](https://doc.getlago.com/docs/api/intro).
+
+## Contributing
+
+The contribution documentation is available [here](https://github.com/getlago/lago-javascript-client/blob/main/CONTRIBUTING.md)
+
+## License
+
+Lago JavaScript client is distributed under [MIT license](LICENSE).

package/esm/swagger/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 0.0.1
+ * @version 0.22.0-beta
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
@@ -546,6 +546,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Return the deleted customer
+         *
+         * @tags customers
+         * @name DeleteCustomer
+         * @summary Delete a customer
+         * @request DELETE:/customers/{external_id}
+         * @secure
+         */
+        deleteCustomer: (externalId, params = {}) => this.request({
+            path: `/customers/${externalId}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description Return a customer current usage
          *
@@ -859,6 +875,21 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Retry invoice payment
+         *
+         * @tags invoices
+         * @name RetryPayment
+         * @summary Retry invoice payment
+         * @request POST:/invoices/{id}/retry_payment
+         * @secure
+         */
+        retryPayment: (id, params = {}) => this.request({
+            path: `/invoices/${id}/retry_payment`,
+            method: "POST",
+            secure: true,
+            ...params,
+        }),
         /**
          * @description Refresh a draft invoice
          *
@@ -995,6 +1026,23 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Find all wallet transactions for certain wallet
+         *
+         * @tags wallets
+         * @name FindAllWalletTransactions
+         * @summary Find wallet transactions
+         * @request GET:/wallets/{id}/wallet_transactions
+         * @secure
+         */
+        findAllWalletTransactions: (id, query, params = {}) => this.request({
+            path: `/wallets/${id}/wallet_transactions`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     walletTransactions = {
         /**

package/package.json

@@ -3,7 +3,8 @@
   "main": "./script/mod.js",
   "types": "./types/mod.d.ts",
   "name": "lago-javascript-client",
-  "version": "v0.20.0-beta",
+  "sideEffects": false,
+  "version": "v0.22.0-beta",
   "description": "Lago JavaScript API Client",
   "repository": {
     "type": "git",

package/script/swagger/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 0.0.1
+ * @version 0.22.0-beta
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
@@ -550,6 +550,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Return the deleted customer
+         *
+         * @tags customers
+         * @name DeleteCustomer
+         * @summary Delete a customer
+         * @request DELETE:/customers/{external_id}
+         * @secure
+         */
+        deleteCustomer: (externalId, params = {}) => this.request({
+            path: `/customers/${externalId}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description Return a customer current usage
          *
@@ -863,6 +879,21 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Retry invoice payment
+         *
+         * @tags invoices
+         * @name RetryPayment
+         * @summary Retry invoice payment
+         * @request POST:/invoices/{id}/retry_payment
+         * @secure
+         */
+        retryPayment: (id, params = {}) => this.request({
+            path: `/invoices/${id}/retry_payment`,
+            method: "POST",
+            secure: true,
+            ...params,
+        }),
         /**
          * @description Refresh a draft invoice
          *
@@ -999,6 +1030,23 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Find all wallet transactions for certain wallet
+         *
+         * @tags wallets
+         * @name FindAllWalletTransactions
+         * @summary Find wallet transactions
+         * @request GET:/wallets/{id}/wallet_transactions
+         * @secure
+         */
+        findAllWalletTransactions: (id, query, params = {}) => this.request({
+            path: `/wallets/${id}/wallet_transactions`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     walletTransactions = {
         /**

package/types/swagger/client.d.ts

@@ -19,6 +19,10 @@ export interface BillableMetricObject {
     /** Aggregation type */
     aggregation_type?: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "recurring_count_agg";
     group?: BillableMetricGroup;
+    /** @example 0 */
+    active_subscriptions_count?: number;
+    /** @example 0 */
+    draft_invoices_count?: number;
 }
 export interface BillableMetric {
     billable_metric?: BillableMetricObject;
@@ -848,6 +852,9 @@ export interface WalletTransactionObject {
 export interface WalletTransaction {
     wallet_transaction?: WalletTransactionObject;
 }
+export interface WalletTransactions {
+    wallet_transactions?: WalletTransactionObject[];
+}
 export interface WalletTransactionInput {
     wallet_transaction?: {
         /** @example "985da83c-c007-4fbb-afcd-b00c07c41ffe" */
@@ -1065,7 +1072,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.0.1
+ * @version 0.22.0-beta
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
@@ -1113,7 +1120,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request DELETE:/billable_metrics/{code}
          * @secure
          */
-        destroyBillableMetric: (code: string, params?: RequestParams) => Promise<HttpResponse<BillableMetric, ApiResponseUnauthorized | ApiResponseNotFound | ApiResponseNotAllowed>>;
+        destroyBillableMetric: (code: string, params?: RequestParams) => Promise<HttpResponse<BillableMetric, ApiResponseUnauthorized | ApiResponseNotFound>>;
         /**
          * @description Find all billable metrics in certain organisation
          *
@@ -1368,6 +1375,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         findCustomer: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiResponseUnauthorized | ApiResponseNotFound>>;
+        /**
+         * @description Return the deleted customer
+         *
+         * @tags customers
+         * @name DeleteCustomer
+         * @summary Delete a customer
+         * @request DELETE:/customers/{external_id}
+         * @secure
+         */
+        deleteCustomer: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Customer, ApiResponseUnauthorized | ApiResponseNotFound | ApiResponseNotAllowed>>;
         /**
          * @description Return a customer current usage
          *
@@ -1602,6 +1619,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         downloadInvoice: (id: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiResponseUnauthorized | ApiResponseNotFound>>;
+        /**
+         * @description Retry invoice payment
+         *
+         * @tags invoices
+         * @name RetryPayment
+         * @summary Retry invoice payment
+         * @request POST:/invoices/{id}/retry_payment
+         * @secure
+         */
+        retryPayment: (id: string, params?: RequestParams) => Promise<HttpResponse<void, ApiResponseUnauthorized | ApiResponseNotFound | ApiResponseNotAllowed>>;
         /**
          * @description Refresh a draft invoice
          *
@@ -1731,6 +1758,37 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             external_customer_id: string;
         }, params?: RequestParams) => Promise<HttpResponse<Wallets, ApiResponseUnauthorized>>;
+        /**
+         * @description Find all wallet transactions for certain wallet
+         *
+         * @tags wallets
+         * @name FindAllWalletTransactions
+         * @summary Find wallet transactions
+         * @request GET:/wallets/{id}/wallet_transactions
+         * @secure
+         */
+        findAllWalletTransactions: (id: string, query?: {
+            /**
+             * Number of page
+             * @example 2
+             */
+            page?: number;
+            /**
+             * Number of records per page
+             * @example 20
+             */
+            per_page?: number;
+            /**
+             * Status (pending or settled)
+             * @example "pending"
+             */
+            status?: string;
+            /**
+             * Transaction Type (inbound or outbound)
+             * @example "inbound"
+             */
+            transaction_type?: string;
+        }, params?: RequestParams) => Promise<HttpResponse<WalletTransactions, ApiResponseUnauthorized | ApiResponseNotFound>>;
     };
     walletTransactions: {
         /**
@@ -1742,7 +1800,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/wallet_transactions
          * @secure
          */
-        createWalletTransaction: (data: WalletTransactionInput, params?: RequestParams) => Promise<HttpResponse<WalletTransaction, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
+        createWalletTransaction: (data: WalletTransactionInput, params?: RequestParams) => Promise<HttpResponse<WalletTransactions, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
     };
     creditNotes: {
         /**