lago-javascript-client 0.19.4-alpha → 0.20.0-beta

package/esm/swagger/client.js

@@ -859,12 +859,44 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Refresh a draft invoice
+         *
+         * @tags invoices
+         * @name RefreshInvoice
+         * @summary Refresh a draft invoice
+         * @request PUT:/invoices/{id}/refresh
+         * @secure
+         */
+        refreshInvoice: (id, params = {}) => this.request({
+            path: `/invoices/${id}/refresh`,
+            method: "PUT",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Finalize a draft invoice
+         *
+         * @tags invoices
+         * @name FinalizeInvoice
+         * @summary Finalize a draft invoice
+         * @request PUT:/invoices/{id}/finalize
+         * @secure
+         */
+        finalizeInvoice: (id, params = {}) => this.request({
+            path: `/invoices/${id}/finalize`,
+            method: "PUT",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description Find all invoices in certain organisation
          *
          * @tags invoices
          * @name FindAllInvoices
-         * @summary Find ainvoices
+         * @summary Find all invoices
          * @request GET:/invoices/
          * @secure
          */

package/package.json

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

package/script/swagger/client.js

@@ -863,12 +863,44 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Refresh a draft invoice
+         *
+         * @tags invoices
+         * @name RefreshInvoice
+         * @summary Refresh a draft invoice
+         * @request PUT:/invoices/{id}/refresh
+         * @secure
+         */
+        refreshInvoice: (id, params = {}) => this.request({
+            path: `/invoices/${id}/refresh`,
+            method: "PUT",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Finalize a draft invoice
+         *
+         * @tags invoices
+         * @name FinalizeInvoice
+         * @summary Finalize a draft invoice
+         * @request PUT:/invoices/{id}/finalize
+         * @secure
+         */
+        finalizeInvoice: (id, params = {}) => this.request({
+            path: `/invoices/${id}/finalize`,
+            method: "PUT",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description Find all invoices in certain organisation
          *
          * @tags invoices
          * @name FindAllInvoices
-         * @summary Find ainvoices
+         * @summary Find all invoices
          * @request GET:/invoices/
          * @secure
          */

package/types/swagger/client.d.ts

@@ -242,10 +242,10 @@ export interface AppliedCouponInput {
 export interface BillingConfigurationOrganization {
     /** @example "text" */
     invoice_footer?: string;
-    /** @example 25 */
-    vat_rate?: number;
     /** @example 5 */
     invoice_grace_period?: number;
+    /** @example 25 */
+    vat_rate?: number;
 }
 export interface OrganizationObject {
     /** @example "183da83c-c007-4fbb-afcd-b00c07c41ffe" */
@@ -311,14 +311,14 @@ export interface OrganizationInput {
 export interface BillingConfigurationCustomer {
     /** @example 3 */
     invoice_grace_period?: number;
-    /** @example 25 */
-    vat_rate?: number;
     /** Payment provider type */
     payment_provider?: "stripe" | "gocardless";
     /** @example 123456 */
     provider_customer_id?: string;
     /** @example true */
     sync_with_provider?: boolean;
+    /** @example 25 */
+    vat_rate?: number;
     [key: string]: any;
 }
 export interface CustomerObject {
@@ -723,9 +723,8 @@ export interface InvoiceObject {
     number?: string;
     /** @example "2022-09-14T16:35:31.000Z" */
     issuing_date?: string;
-    /** Invoice type */
     invoice_type?: "subscription" | "add_on" | "credit";
-    /** Status */
+    status?: "draft" | "finalized";
     payment_status?: "pending" | "succeeded" | "failed";
     /** @example 1200 */
     amount_cents?: number;
@@ -1603,12 +1602,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         downloadInvoice: (id: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiResponseUnauthorized | ApiResponseNotFound>>;
+        /**
+         * @description Refresh a draft invoice
+         *
+         * @tags invoices
+         * @name RefreshInvoice
+         * @summary Refresh a draft invoice
+         * @request PUT:/invoices/{id}/refresh
+         * @secure
+         */
+        refreshInvoice: (id: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiResponseUnauthorized | ApiResponseNotFound>>;
+        /**
+         * @description Finalize a draft invoice
+         *
+         * @tags invoices
+         * @name FinalizeInvoice
+         * @summary Finalize a draft invoice
+         * @request PUT:/invoices/{id}/finalize
+         * @secure
+         */
+        finalizeInvoice: (id: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiResponseUnauthorized | ApiResponseNotFound>>;
         /**
          * @description Find all invoices in certain organisation
          *
          * @tags invoices
          * @name FindAllInvoices
-         * @summary Find ainvoices
+         * @summary Find all invoices
          * @request GET:/invoices/
          * @secure
          */
@@ -1638,6 +1657,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "2022-08-09T00:00:00.000Z"
              */
             issuing_date_to?: string;
+            /**
+             * Status (draft or finalized)
+             * @example "draft"
+             */
+            status?: string;
         }, params?: RequestParams) => Promise<HttpResponse<Invoices, ApiResponseUnauthorized>>;
     };
     wallets: {

package/LICENSE

@@ -1,21 +0,0 @@
-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

@@ -1,115 +0,0 @@
-# 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 Node.js client is distributed under [AGPL-3.0](LICENSE).