lago-javascript-client 0.28.0-beta → 0.29.0-beta

package/package.json

@@ -4,7 +4,7 @@
   "types": "./types/mod.d.ts",
   "name": "lago-javascript-client",
   "sideEffects": false,
-  "version": "v0.28.0-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": {

package/types/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 */
@@ -1180,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?: {
@@ -1251,6 +1271,9 @@ export interface WalletTransaction {
 export interface WalletTransactions {
     wallet_transactions: WalletTransactionObject[];
 }
+export type WalletTransactionsPaginated = WalletTransactions & {
+    meta: PaginationMeta;
+};
 export interface WalletTransactionInput {
     wallet_transaction: {
         /**
@@ -1342,7 +1365,6 @@ export interface CreditNoteObject {
     updated_at: string;
     /** @example "https://example.com" */
     file_url?: string;
-    customer?: CustomerObject;
     items?: CreditNoteItemObject[];
 }
 export interface CreditNote {
@@ -1557,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
          *
@@ -1608,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: {
         /**
@@ -1641,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
          *
@@ -1716,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
          *
@@ -1786,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: {
         /**
@@ -1831,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
          *
@@ -1967,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
          *
@@ -2035,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
          *
@@ -2109,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
          *
@@ -2328,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
          *
@@ -2389,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: {
         /**