lago-javascript-client 0.32.0-beta → 0.36.0-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -148,7 +148,7 @@ export class HttpClient {
148
148
  }
149
149
  /**
150
150
  * @title Lago API documentation
151
- * @version 0.30.0-beta
151
+ * @version 0.36.0-beta
152
152
  * @baseUrl https://api.getlago.com/api/v1
153
153
  * @externalDocs https://github.com/getlago
154
154
  * @contact <tech@getlago.com>
@@ -681,11 +681,11 @@ export class Api extends HttpClient {
681
681
  ...params,
682
682
  }),
683
683
  /**
684
- * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple instant charges
684
+ * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance charges
685
685
  *
686
686
  * @tags events
687
687
  * @name EventEstimateFees
688
- * @summary Estimate fees for an instant charge
688
+ * @summary Estimate fees for an pay in advance charge
689
689
  * @request POST:/events/estimate_fees
690
690
  * @secure
691
691
  */
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "types": "./types/mod.d.ts",
5
5
  "name": "lago-javascript-client",
6
6
  "sideEffects": false,
7
- "version": "v0.32.0-beta",
7
+ "version": "v0.36.0-beta",
8
8
  "description": "Lago JavaScript API Client",
9
9
  "repository": {
10
10
  "type": "git",
@@ -152,7 +152,7 @@ class HttpClient {
152
152
  exports.HttpClient = HttpClient;
153
153
  /**
154
154
  * @title Lago API documentation
155
- * @version 0.30.0-beta
155
+ * @version 0.36.0-beta
156
156
  * @baseUrl https://api.getlago.com/api/v1
157
157
  * @externalDocs https://github.com/getlago
158
158
  * @contact <tech@getlago.com>
@@ -685,11 +685,11 @@ class Api extends HttpClient {
685
685
  ...params,
686
686
  }),
687
687
  /**
688
- * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple instant charges
688
+ * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance charges
689
689
  *
690
690
  * @tags events
691
691
  * @name EventEstimateFees
692
- * @summary Estimate fees for an instant charge
692
+ * @summary Estimate fees for an pay in advance charge
693
693
  * @request POST:/events/estimate_fees
694
694
  * @secure
695
695
  */
@@ -366,6 +366,8 @@ export interface OrganizationObject {
366
366
  legal_name?: string;
367
367
  /** @example "10000" */
368
368
  legal_number?: string;
369
+ /** @example "EU123456789" */
370
+ tax_identification_number?: string;
369
371
  /** @example "UTC" */
370
372
  timezone?: string;
371
373
  billing_configuration?: BillingConfigurationOrganization;
@@ -398,6 +400,8 @@ export interface OrganizationInput {
398
400
  legal_name?: string;
399
401
  /** @example "10000" */
400
402
  legal_number?: string;
403
+ /** @example "EU123456789" */
404
+ tax_identification_number?: string;
401
405
  /** @example "Europe/Paris" */
402
406
  timezone?: string;
403
407
  email_settings?: ("invoice.finalized" | "credit_note.created")[];
@@ -483,6 +487,8 @@ export interface CustomerObject {
483
487
  legal_name?: string;
484
488
  /** @example "10000" */
485
489
  legal_number?: string;
490
+ /** @example "EU123456789" */
491
+ tax_identification_number?: string;
486
492
  /** @example "EUR" */
487
493
  currency?: string;
488
494
  /** @example "UTC" */
@@ -532,6 +538,8 @@ export interface CustomerInput {
532
538
  legal_name?: string;
533
539
  /** @example "10000" */
534
540
  legal_number?: string;
541
+ /** @example "EU123456789" */
542
+ tax_identification_number?: string;
535
543
  /** @example "EUR" */
536
544
  currency?: string;
537
545
  /** @example "Europe/Paris" */
@@ -567,7 +575,7 @@ export interface ChargeUsageObject {
567
575
  lago_id?: string;
568
576
  /** Charge model type */
569
577
  charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
570
- instant?: boolean;
578
+ pay_in_advance?: boolean;
571
579
  /** @example 1200 */
572
580
  min_amount_cents?: number;
573
581
  };
@@ -750,7 +758,9 @@ export interface ChargeObject {
750
758
  /** Charge model type */
751
759
  charge_model: "standard" | "graduated" | "package" | "percentage" | "volume";
752
760
  /** @example true */
753
- instant?: boolean;
761
+ pay_in_advance?: boolean;
762
+ /** @example true */
763
+ invoiceable?: boolean;
754
764
  /** @example 1200 */
755
765
  min_amount_cents?: number;
756
766
  properties?: object;
@@ -831,7 +841,8 @@ export interface PlanInput {
831
841
  billable_metric_id?: string;
832
842
  /** Charge model type */
833
843
  charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
834
- instant?: boolean;
844
+ pay_in_advance?: boolean;
845
+ invoiceable?: boolean;
835
846
  min_amount_cents?: number;
836
847
  properties?: object;
837
848
  group_properties?: {
@@ -1015,6 +1026,10 @@ export interface FeeObject {
1015
1026
  total_amount_currency?: string;
1016
1027
  /** @example 5 */
1017
1028
  events_count?: number;
1029
+ /** @example true */
1030
+ pay_in_advance?: boolean;
1031
+ /** @example true */
1032
+ invoiceable?: boolean;
1018
1033
  /**
1019
1034
  * @format date-time
1020
1035
  * @example "2022-08-08T00:00:00Z"
@@ -1623,7 +1638,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
1623
1638
  }
1624
1639
  /**
1625
1640
  * @title Lago API documentation
1626
- * @version 0.30.0-beta
1641
+ * @version 0.36.0-beta
1627
1642
  * @baseUrl https://api.getlago.com/api/v1
1628
1643
  * @externalDocs https://github.com/getlago
1629
1644
  * @contact <tech@getlago.com>
@@ -2031,11 +2046,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
2031
2046
  */
2032
2047
  findEvent: (id: string, params?: RequestParams) => Promise<HttpResponse<Event, ApiResponseUnauthorized | ApiResponseNotFound>>;
2033
2048
  /**
2034
- * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple instant charges
2049
+ * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance charges
2035
2050
  *
2036
2051
  * @tags events
2037
2052
  * @name EventEstimateFees
2038
- * @summary Estimate fees for an instant charge
2053
+ * @summary Estimate fees for an pay in advance charge
2039
2054
  * @request POST:/events/estimate_fees
2040
2055
  * @secure
2041
2056
  */
@@ -2124,7 +2139,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
2124
2139
  * @request GET:/subscriptions
2125
2140
  * @secure
2126
2141
  */
2127
- findAllSubscriptions: (query: {
2142
+ findAllSubscriptions: (query?: {
2128
2143
  /**
2129
2144
  * Number of page
2130
2145
  * @example 2
@@ -2139,7 +2154,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
2139
2154
  * External customer ID
2140
2155
  * @example "12345"
2141
2156
  */
2142
- external_customer_id: string;
2157
+ external_customer_id?: string;
2158
+ /**
2159
+ * Code of the plan attached to the subscription
2160
+ * @example "example_code"
2161
+ */
2162
+ plan_code?: string;
2143
2163
  }, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiResponseUnauthorized | ApiResponseNotFound>>;
2144
2164
  /**
2145
2165
  * @description Update an existing subscription by external ID