@openmeter/sdk 1.0.0-beta.227 → 1.0.0-beta.229

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.
package/Makefile CHANGED
@@ -8,7 +8,6 @@ generate: ## Generate JavaScript SDK
8
8
  pnpm build
9
9
  pnpm test
10
10
 
11
- # Warning: keep in sync with .dagger/release.go for now
12
11
  .PHONY: publish-javascript-sdk
13
12
  publish-javascript-sdk: ## Publish JavaScript SDK
14
13
  $(call print-target)
@@ -590,6 +590,9 @@ export declare class CustomerEntitlementsV2 {
590
590
  readonly overage?: number;
591
591
  readonly totalAvailableGrantAmount?: number;
592
592
  readonly config?: string;
593
+ readonly grantBalances?: {
594
+ [key: string]: number;
595
+ };
593
596
  } | undefined>;
594
597
  /**
595
598
  * Get the history of a customer entitlement
@@ -29,6 +29,7 @@ export declare class Features {
29
29
  advancedMeterGroupByFilters?: {
30
30
  [key: string]: import("./schemas.cjs").components["schemas"]["FilterString"];
31
31
  };
32
+ unitCost?: import("./schemas.cjs").components["schemas"]["FeatureUnitCost"];
32
33
  readonly id: string;
33
34
  } | undefined>;
34
35
  /**
@@ -52,6 +53,7 @@ export declare class Features {
52
53
  advancedMeterGroupByFilters?: {
53
54
  [key: string]: import("./schemas.cjs").components["schemas"]["FilterString"];
54
55
  };
56
+ unitCost?: import("./schemas.cjs").components["schemas"]["FeatureUnitCost"];
55
57
  readonly id: string;
56
58
  } | undefined>;
57
59
  /**
@@ -75,6 +77,7 @@ export declare class Features {
75
77
  advancedMeterGroupByFilters?: {
76
78
  [key: string]: import("./schemas.cjs").components["schemas"]["FilterString"];
77
79
  };
80
+ unitCost?: import("./schemas.cjs").components["schemas"]["FeatureUnitCost"];
78
81
  readonly id: string;
79
82
  }[]>;
80
83
  /**
@@ -18,7 +18,7 @@ class Meters {
18
18
  * @returns The created meter
19
19
  */
20
20
  async create(meter, options) {
21
- const resp = await this.client.POST('/api/v1/meters', {
21
+ const resp = await this.client.POST("/api/v1/meters", {
22
22
  body: meter,
23
23
  ...options,
24
24
  });
@@ -31,7 +31,7 @@ class Meters {
31
31
  * @returns The meter
32
32
  */
33
33
  async get(idOrSlug, options) {
34
- const resp = await this.client.GET('/api/v1/meters/{meterIdOrSlug}', {
34
+ const resp = await this.client.GET("/api/v1/meters/{meterIdOrSlug}", {
35
35
  params: {
36
36
  path: {
37
37
  meterIdOrSlug: idOrSlug,
@@ -47,7 +47,7 @@ class Meters {
47
47
  * @returns The meters
48
48
  */
49
49
  async list(options) {
50
- const resp = await this.client.GET('/api/v1/meters', {
50
+ const resp = await this.client.GET("/api/v1/meters", {
51
51
  ...options,
52
52
  });
53
53
  return (0, utils_js_1.transformResponse)(resp);
@@ -60,9 +60,9 @@ class Meters {
60
60
  * @returns The meter data
61
61
  */
62
62
  async query(idOrSlug, query, options) {
63
- const resp = await this.client.GET('/api/v1/meters/{meterIdOrSlug}/query', {
63
+ const resp = await this.client.GET("/api/v1/meters/{meterIdOrSlug}/query", {
64
64
  headers: {
65
- Accept: 'application/json',
65
+ Accept: "application/json",
66
66
  },
67
67
  params: {
68
68
  path: {
@@ -82,7 +82,7 @@ class Meters {
82
82
  * @returns The updated meter
83
83
  */
84
84
  async update(idOrSlug, meter, options) {
85
- const resp = await this.client.PUT('/api/v1/meters/{meterIdOrSlug}', {
85
+ const resp = await this.client.PUT("/api/v1/meters/{meterIdOrSlug}", {
86
86
  body: meter,
87
87
  params: {
88
88
  path: {
@@ -100,7 +100,7 @@ class Meters {
100
100
  * @returns The deleted meter
101
101
  */
102
102
  async delete(idOrSlug, options) {
103
- const resp = await this.client.DELETE('/api/v1/meters/{meterIdOrSlug}', {
103
+ const resp = await this.client.DELETE("/api/v1/meters/{meterIdOrSlug}", {
104
104
  params: {
105
105
  path: {
106
106
  meterIdOrSlug: idOrSlug,
@@ -120,7 +120,7 @@ class Meters {
120
120
  * @returns The list of group-by values
121
121
  */
122
122
  async listGroupByValues(idOrSlug, groupByKey, query, options) {
123
- const resp = await this.client.GET('/api/v1/meters/{meterIdOrSlug}/group-by/{groupByKey}/values', {
123
+ const resp = await this.client.GET("/api/v1/meters/{meterIdOrSlug}/group-by/{groupByKey}/values", {
124
124
  params: {
125
125
  path: {
126
126
  groupByKey,
@@ -141,10 +141,10 @@ class Meters {
141
141
  * @returns The meter data
142
142
  */
143
143
  async queryPost(idOrSlug, body, options) {
144
- const resp = await this.client.POST('/api/v1/meters/{meterIdOrSlug}/query', {
144
+ const resp = await this.client.POST("/api/v1/meters/{meterIdOrSlug}/query", {
145
145
  body,
146
146
  headers: {
147
- Accept: 'application/json',
147
+ Accept: "application/json",
148
148
  },
149
149
  params: {
150
150
  path: {
@@ -1,6 +1,6 @@
1
- import type { Client } from 'openapi-fetch';
2
- import type { RequestOptions } from './common.cjs';
3
- import type { MeterCreate, operations, paths } from './schemas.cjs';
1
+ import type { Client } from "openapi-fetch";
2
+ import type { RequestOptions } from "./common.cjs";
3
+ import type { MeterCreate, operations, paths } from "./schemas.cjs";
4
4
  /**
5
5
  * Meters
6
6
  * @description Meters are used to track and manage usage of your application.
@@ -38,7 +38,7 @@ export declare class Meters {
38
38
  * @param signal - An optional abort signal
39
39
  * @returns The meter
40
40
  */
41
- get(idOrSlug: operations['getMeter']['parameters']['path']['meterIdOrSlug'], options?: RequestOptions): Promise<{
41
+ get(idOrSlug: operations["getMeter"]["parameters"]["path"]["meterIdOrSlug"], options?: RequestOptions): Promise<{
42
42
  readonly id: string;
43
43
  description?: string;
44
44
  metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
@@ -86,7 +86,7 @@ export declare class Meters {
86
86
  * @param signal - An optional abort signal
87
87
  * @returns The meter data
88
88
  */
89
- query(idOrSlug: operations['queryMeter']['parameters']['path']['meterIdOrSlug'], query?: operations['queryMeter']['parameters']['query'], options?: RequestOptions): Promise<{
89
+ query(idOrSlug: operations["queryMeter"]["parameters"]["path"]["meterIdOrSlug"], query?: operations["queryMeter"]["parameters"]["query"], options?: RequestOptions): Promise<{
90
90
  from?: Date;
91
91
  to?: Date;
92
92
  windowSize?: import("./schemas.cjs").components["schemas"]["WindowSize"];
@@ -99,7 +99,7 @@ export declare class Meters {
99
99
  * @param options - Optional request options
100
100
  * @returns The updated meter
101
101
  */
102
- update(idOrSlug: operations['updateMeter']['parameters']['path']['meterIdOrSlug'], meter: operations['updateMeter']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<{
102
+ update(idOrSlug: operations["updateMeter"]["parameters"]["path"]["meterIdOrSlug"], meter: operations["updateMeter"]["requestBody"]["content"]["application/json"], options?: RequestOptions): Promise<{
103
103
  readonly id: string;
104
104
  description?: string;
105
105
  metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
@@ -123,7 +123,7 @@ export declare class Meters {
123
123
  * @param signal - An optional abort signal
124
124
  * @returns The deleted meter
125
125
  */
126
- delete(idOrSlug: operations['deleteMeter']['parameters']['path']['meterIdOrSlug'], options?: RequestOptions): Promise<undefined>;
126
+ delete(idOrSlug: operations["deleteMeter"]["parameters"]["path"]["meterIdOrSlug"], options?: RequestOptions): Promise<undefined>;
127
127
  /**
128
128
  * List meter group-by values
129
129
  * @description List all values for a specific group-by key in a meter.
@@ -133,7 +133,7 @@ export declare class Meters {
133
133
  * @param options - Optional request options
134
134
  * @returns The list of group-by values
135
135
  */
136
- listGroupByValues(idOrSlug: operations['listMeterGroupByValues']['parameters']['path']['meterIdOrSlug'], groupByKey: operations['listMeterGroupByValues']['parameters']['path']['groupByKey'], query?: operations['listMeterGroupByValues']['parameters']['query'], options?: RequestOptions): Promise<string[] | undefined>;
136
+ listGroupByValues(idOrSlug: operations["listMeterGroupByValues"]["parameters"]["path"]["meterIdOrSlug"], groupByKey: operations["listMeterGroupByValues"]["parameters"]["path"]["groupByKey"], query?: operations["listMeterGroupByValues"]["parameters"]["query"], options?: RequestOptions): Promise<string[] | undefined>;
137
137
  /**
138
138
  * Query usage data for a meter by ID or slug using POST
139
139
  * @description Query meter using POST method. This is useful for complex queries that exceed URL length limits.
@@ -142,10 +142,79 @@ export declare class Meters {
142
142
  * @param options - Optional request options
143
143
  * @returns The meter data
144
144
  */
145
- queryPost(idOrSlug: operations['queryMeterPost']['parameters']['path']['meterIdOrSlug'], body: operations['queryMeterPost']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<{
146
- from?: Date;
147
- to?: Date;
148
- windowSize?: import("./schemas.cjs").components["schemas"]["WindowSize"];
149
- data: import("./schemas.cjs").components["schemas"]["MeterQueryRow"][];
150
- } | undefined>;
145
+ queryPost(idOrSlug: operations["queryMeterPost"]["parameters"]["path"]["meterIdOrSlug"], body: operations["queryMeterPost"]["requestBody"]["content"]["application/json"], options?: RequestOptions): Promise<import("openapi-typescript-helpers").SuccessResponse<{
146
+ 200: {
147
+ headers: {
148
+ [name: string]: unknown;
149
+ };
150
+ content: {
151
+ "application/json": import("./schemas.cjs").components["schemas"]["MeterQueryResult"];
152
+ "text/csv": string;
153
+ };
154
+ };
155
+ 400: {
156
+ headers: {
157
+ [name: string]: unknown;
158
+ };
159
+ content: {
160
+ "application/problem+json": import("./schemas.cjs").components["schemas"]["BadRequestProblemResponse"];
161
+ };
162
+ };
163
+ 401: {
164
+ headers: {
165
+ [name: string]: unknown;
166
+ };
167
+ content: {
168
+ "application/problem+json": import("./schemas.cjs").components["schemas"]["UnauthorizedProblemResponse"];
169
+ };
170
+ };
171
+ 403: {
172
+ headers: {
173
+ [name: string]: unknown;
174
+ };
175
+ content: {
176
+ "application/problem+json": import("./schemas.cjs").components["schemas"]["ForbiddenProblemResponse"];
177
+ };
178
+ };
179
+ 404: {
180
+ headers: {
181
+ [name: string]: unknown;
182
+ };
183
+ content: {
184
+ "application/problem+json": import("./schemas.cjs").components["schemas"]["NotFoundProblemResponse"];
185
+ };
186
+ };
187
+ 412: {
188
+ headers: {
189
+ [name: string]: unknown;
190
+ };
191
+ content: {
192
+ "application/problem+json": import("./schemas.cjs").components["schemas"]["PreconditionFailedProblemResponse"];
193
+ };
194
+ };
195
+ 500: {
196
+ headers: {
197
+ [name: string]: unknown;
198
+ };
199
+ content: {
200
+ "application/problem+json": import("./schemas.cjs").components["schemas"]["InternalServerErrorProblemResponse"];
201
+ };
202
+ };
203
+ 503: {
204
+ headers: {
205
+ [name: string]: unknown;
206
+ };
207
+ content: {
208
+ "application/problem+json": import("./schemas.cjs").components["schemas"]["ServiceUnavailableProblemResponse"];
209
+ };
210
+ };
211
+ default: {
212
+ headers: {
213
+ [name: string]: unknown;
214
+ };
215
+ content: {
216
+ "application/problem+json": import("./schemas.cjs").components["schemas"]["UnexpectedProblemResponse"];
217
+ };
218
+ };
219
+ }, `${string}/${string}`> | undefined>;
151
220
  }
@@ -32,6 +32,7 @@ export declare class Plans {
32
32
  readonly effectiveFrom?: Date;
33
33
  readonly effectiveTo?: Date;
34
34
  readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
35
+ settlementMode?: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
35
36
  phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
36
37
  readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
37
38
  } | undefined>;
@@ -59,6 +60,7 @@ export declare class Plans {
59
60
  readonly effectiveFrom?: Date;
60
61
  readonly effectiveTo?: Date;
61
62
  readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
63
+ settlementMode?: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
62
64
  phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
63
65
  readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
64
66
  } | undefined>;
@@ -98,6 +100,7 @@ export declare class Plans {
98
100
  readonly effectiveFrom?: Date;
99
101
  readonly effectiveTo?: Date;
100
102
  readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
103
+ settlementMode?: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
101
104
  phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
102
105
  readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
103
106
  } | undefined>;
@@ -131,6 +134,7 @@ export declare class Plans {
131
134
  readonly effectiveFrom?: Date;
132
135
  readonly effectiveTo?: Date;
133
136
  readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
137
+ settlementMode?: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
134
138
  phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
135
139
  readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
136
140
  } | undefined>;
@@ -157,6 +161,7 @@ export declare class Plans {
157
161
  readonly effectiveFrom?: Date;
158
162
  readonly effectiveTo?: Date;
159
163
  readonly status: import("./schemas.cjs").components["schemas"]["PlanStatus"];
164
+ settlementMode?: import("./schemas.cjs").components["schemas"]["BillingSettlementMode"];
160
165
  phases: import("./schemas.cjs").components["schemas"]["PlanPhase"][];
161
166
  readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
162
167
  } | undefined>;