lago-javascript-client 0.27.1-beta → 0.29.0-beta

package/README.md

@@ -1,6 +1,6 @@
 # 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/#/).
+This is a JavaScript wrapper for Lago API. Works in Cloudflare Workers, Deno, and Node.js. Generated from [the Lago OpenAPI 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)
@@ -76,10 +76,10 @@ Change the affected fields in `scripts/build_npm.ts` and commit to GitHub. GitHu
 
 Requires [Deno](https://deno.land/) and [Node.js >= 18](https://nodejs.org/en/)
 
-### Generate client from Swagger
+### Generate client from OpenAPI
 
 ```bash
-deno task generate:swagger
+deno task generate:openapi
 ```
 
 ### Run tests

package/esm/mod.js

@@ -1,5 +1,5 @@
 // deno-lint-ignore-file no-explicit-any
-import { Api } from "./swagger/client.js";
+import { Api } from "./openapi/client.js";
 export const Client = (apiKey, apiConfig) => {
     const api = new Api({
         securityWorker: (apiKey) => apiKey ? { headers: { Authorization: `Bearer ${apiKey}` } } : {},
@@ -30,4 +30,4 @@ export async function getLagoError(error) {
     }
     throw new Error(error);
 }
-export * from "./swagger/client.js";
+export * from "./openapi/client.js";

package/esm/{swagger → openapi}/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 0.26.0-beta
+ * @version 0.28.0-beta
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>

package/package.json

@@ -4,7 +4,7 @@
   "types": "./types/mod.d.ts",
   "name": "lago-javascript-client",
   "sideEffects": false,
-  "version": "v0.27.1-beta",
+  "version": "v0.29.0-beta",
   "description": "Lago JavaScript API Client",
   "repository": {
     "type": "git",
@@ -19,7 +19,8 @@
   "contributors": [
     "Lovro Colic",
     "Jérémy Denquin",
-    "Arjun Yelamanchili"
+    "Arjun Yelamanchili",
+    "Vincent Pochet"
   ],
   "license": "MIT",
   "bugs": {
@@ -44,7 +45,7 @@
   "devDependencies": {
     "@types/node": "^18.11.9",
     "chalk": "^4.1.2",
-    "@deno/shim-deno": "~0.12.0",
+    "@deno/shim-deno": "~0.14.0",
     "urlpattern-polyfill": "^6.0.2"
   }
 }

package/script/mod.js

@@ -16,7 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLagoError = exports.Client = void 0;
 // deno-lint-ignore-file no-explicit-any
-const client_js_1 = require("./swagger/client.js");
+const client_js_1 = require("./openapi/client.js");
 const Client = (apiKey, apiConfig) => {
     const api = new client_js_1.Api({
         securityWorker: (apiKey) => apiKey ? { headers: { Authorization: `Bearer ${apiKey}` } } : {},
@@ -49,4 +49,4 @@ async function getLagoError(error) {
     throw new Error(error);
 }
 exports.getLagoError = getLagoError;
-__exportStar(require("./swagger/client.js"), exports);
+__exportStar(require("./openapi/client.js"), exports);

package/script/{swagger → openapi}/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 0.26.0-beta
+ * @version 0.28.0-beta
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>

package/types/mod.d.ts

@@ -1,5 +1,5 @@
-import { Api, ApiConfig, HttpResponse } from "./swagger/client.js";
+import { Api, ApiConfig, HttpResponse } from "./openapi/client.js";
 export declare const Client: (apiKey: string, apiConfig?: ApiConfig) => Api<unknown>;
 type ExtractLagoError<E> = E extends (...args: any) => Promise<HttpResponse<infer T, infer P>> ? P : never;
 export declare function getLagoError<T>(error: any): Promise<ExtractLagoError<T>>;
-export * from "./swagger/client.js";
+export * from "./openapi/client.js";

package/types/{swagger → openapi}/client.d.ts

@@ -35,8 +35,9 @@ export interface BillableMetricObject {
 export interface BillableMetric {
     billable_metric: BillableMetricObject;
 }
-export interface BillableMetrics {
+export interface BillableMetricsPaginated {
     billable_metrics: BillableMetricObject[];
+    meta: PaginationMeta;
 }
 export interface BillableMetricInput {
     billable_metric: {
@@ -64,8 +65,9 @@ export interface GroupObject {
     /** @example "EU" */
     value: string;
 }
-export interface Groups {
+export interface GroupsPaginated {
     groups: GroupObject[];
+    meta: PaginationMeta;
 }
 export interface AddOnObject {
     /**
@@ -92,8 +94,9 @@ export interface AddOnObject {
 export interface AddOn {
     add_on: AddOnObject;
 }
-export interface AddOns {
+export interface AddOnsPaginated {
     add_ons: AddOnObject[];
+    meta: PaginationMeta;
 }
 export interface AddOnInput {
     add_on: {
@@ -175,6 +178,9 @@ export interface CouponObject {
     /** @example true */
     limited_plans?: boolean;
     plan_codes?: string[];
+    /** @example true */
+    limited_billable_metrics?: boolean;
+    billable_metric_codes?: string[];
     /**
      * @format date-time
      * @example "2022-09-14T16:35:31Z"
@@ -197,8 +203,9 @@ export interface CouponObject {
 export interface Coupon {
     coupon: CouponObject;
 }
-export interface Coupons {
+export interface CouponsPaginated {
     coupons: CouponObject[];
+    meta: PaginationMeta;
 }
 export interface CouponInput {
     coupon: {
@@ -229,6 +236,7 @@ export interface CouponInput {
         expiration?: "no_expiration" | "time_limit";
         applies_to?: {
             plan_codes?: string[];
+            billable_metric_codes?: string[];
         };
     };
 }
@@ -283,13 +291,16 @@ export interface AppliedCouponObject {
      * @example "2022-09-14T16:35:31Z"
      */
     terminated_at?: string;
-    credits: CreditObject[];
 }
+export type AppliedCouponObjectExtended = AppliedCouponObject & {
+    credits: CreditObject[];
+};
 export interface AppliedCoupon {
     applied_coupon: AppliedCouponObject;
 }
-export interface AppliedCoupons {
-    applied_coupons: AppliedCouponObject[];
+export interface AppliedCouponsPaginated {
+    applied_coupons: AppliedCouponObjectExtended[];
+    meta: PaginationMeta;
 }
 export interface AppliedCouponInput {
     applied_coupon: {
@@ -484,8 +495,9 @@ export interface CustomerObject {
 export interface Customer {
     customer: CustomerObject;
 }
-export interface Customers {
+export interface CustomersPaginated {
     customers: CustomerObject[];
+    meta: PaginationMeta;
 }
 export interface CustomerInput {
     customer: {
@@ -701,10 +713,9 @@ export interface BatchEventInput {
 export interface Fees {
     fees: FeeObject[];
 }
-export interface FeesPaginated {
-    fees: FeeObject[];
+export type FeesPaginated = Fees & {
     meta: PaginationMeta;
-}
+};
 export interface FeeUpdateInput {
     invoice: {
         /** Status */
@@ -779,8 +790,9 @@ export interface PlanObject {
 export interface Plan {
     plan: PlanObject;
 }
-export interface Plans {
+export interface PlansPaginated {
     plans: PlanObject[];
+    meta: PaginationMeta;
 }
 export interface PlanInput {
     plan: {
@@ -886,8 +898,9 @@ export interface SubscriptionObject {
 export interface Subscription {
     subscription: SubscriptionObject;
 }
-export interface Subscriptions {
+export interface SubscriptionsPaginated {
     subscriptions: SubscriptionObject[];
+    meta: PaginationMeta;
 }
 export interface SubscriptionCreateInput {
     subscription: {
@@ -1091,17 +1104,23 @@ export interface InvoiceObject {
     /** @example "https://example.com" */
     file_url?: string;
     customer: CustomerObject;
-    subscriptions: SubscriptionObject[];
     metadata?: InvoiceMetadataObject[];
-    fees: FeeObject[];
-    credits: CreditObject[];
 }
+export type InvoiceObjectExtended = InvoiceObject & {
+    credits: CreditObject[];
+    fees: FeeObject[];
+    subscriptions: SubscriptionObject[];
+};
 export interface Invoice {
-    invoice: InvoiceObject;
+    invoice: InvoiceObjectExtended;
 }
 export interface Invoices {
     invoices: InvoiceObject[];
 }
+export interface InvoicesPaginated {
+    invoices: InvoiceObject[];
+    meta: PaginationMeta;
+}
 export interface InvoiceInput {
     invoice: {
         /** Status */
@@ -1142,8 +1161,13 @@ export interface WalletObject {
     rate_amount: number;
     /** @example 500 */
     credits_balance: number;
-    /** @example 1000 */
+    /**
+     * @deprecated
+     * @example 1000
+     */
     balance: number;
+    /** @example 100000 */
+    balance_cents: number;
     /** @example 100 */
     consumed_credits: number;
     /**
@@ -1175,8 +1199,9 @@ export interface WalletObject {
 export interface Wallet {
     wallet: WalletObject;
 }
-export interface Wallets {
+export interface WalletsPaginated {
     wallets: WalletObject[];
+    meta: PaginationMeta;
 }
 export interface WalletInput {
     wallet?: {
@@ -1246,6 +1271,9 @@ export interface WalletTransaction {
 export interface WalletTransactions {
     wallet_transactions: WalletTransactionObject[];
 }
+export type WalletTransactionsPaginated = WalletTransactions & {
+    meta: PaginationMeta;
+};
 export interface WalletTransactionInput {
     wallet_transaction: {
         /**
@@ -1337,7 +1365,6 @@ export interface CreditNoteObject {
     updated_at: string;
     /** @example "https://example.com" */
     file_url?: string;
-    customer?: CustomerObject;
     items?: CreditNoteItemObject[];
 }
 export interface CreditNote {
@@ -1513,7 +1540,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.26.0-beta
+ * @version 0.28.0-beta
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
  * @contact <tech@getlago.com>
@@ -1552,7 +1579,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<BillableMetrics, ApiResponseUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<BillableMetricsPaginated, ApiResponseUnauthorized>>;
         /**
          * @description Update an existing billable metric by code
          *
@@ -1603,7 +1630,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<Groups, ApiResponseUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<GroupsPaginated, ApiResponseUnauthorized>>;
     };
     addOns: {
         /**
@@ -1636,7 +1663,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<AddOns, ApiResponseUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<AddOnsPaginated, ApiResponseUnauthorized>>;
         /**
          * @description Update an existing add-on by code
          *
@@ -1711,7 +1738,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<Coupons, ApiResponseUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<CouponsPaginated, ApiResponseUnauthorized>>;
         /**
          * @description Update an existing coupon by code
          *
@@ -1781,7 +1808,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "12345"
              */
             external_customer_id?: string;
-        }, params?: RequestParams) => Promise<HttpResponse<AppliedCoupons, ApiResponseUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<AppliedCouponsPaginated, ApiResponseUnauthorized>>;
     };
     organizations: {
         /**
@@ -1826,7 +1853,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<Customers, ApiResponseUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<CustomersPaginated, ApiResponseUnauthorized>>;
         /**
          * @description Return a single customer
          *
@@ -1962,7 +1989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example 20
              */
             per_page?: number;
-        }, params?: RequestParams) => Promise<HttpResponse<Plans, ApiResponseUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<PlansPaginated, ApiResponseUnauthorized>>;
         /**
          * @description Update an existing plan by code
          *
@@ -2030,7 +2057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "12345"
              */
             external_customer_id: string;
-        }, params?: RequestParams) => Promise<HttpResponse<Subscriptions, ApiResponseUnauthorized | ApiResponseNotFound>>;
+        }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiResponseUnauthorized | ApiResponseNotFound>>;
         /**
          * @description Update an existing subscription by external ID
          *
@@ -2104,7 +2131,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             issuing_date_to?: string;
             /** Status */
             status?: "draft" | "finalized";
-        }, params?: RequestParams) => Promise<HttpResponse<Invoices, ApiResponseUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<InvoicesPaginated, ApiResponseUnauthorized>>;
         /**
          * @description Update an existing invoice
          *
@@ -2323,7 +2350,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "12345"
              */
             external_customer_id: string;
-        }, params?: RequestParams) => Promise<HttpResponse<Wallets, ApiResponseUnauthorized>>;
+        }, params?: RequestParams) => Promise<HttpResponse<WalletsPaginated, ApiResponseUnauthorized>>;
         /**
          * @description Update an existing wallet
          *
@@ -2384,7 +2411,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @example "inbound"
              */
             transaction_type?: string;
-        }, params?: RequestParams) => Promise<HttpResponse<WalletTransactions, ApiResponseUnauthorized | ApiResponseNotFound>>;
+        }, params?: RequestParams) => Promise<HttpResponse<WalletTransactionsPaginated, ApiResponseUnauthorized | ApiResponseNotFound>>;
     };
     walletTransactions: {
         /**