@openmeter/sdk 1.0.0-beta.23 → 1.0.0-beta.231
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/README.md +234 -146
- package/dist/cjs/index.cjs +18 -0
- package/dist/cjs/index.cjs.map +1 -0
- package/dist/cjs/index.d.cts +1 -0
- package/dist/cjs/src/client/addons.cjs +105 -0
- package/dist/cjs/src/client/addons.cjs.map +1 -0
- package/dist/cjs/src/client/addons.d.cts +152 -0
- package/dist/cjs/src/client/apps.cjs +247 -0
- package/dist/cjs/src/client/apps.cjs.map +1 -0
- package/dist/cjs/src/client/apps.d.cts +327 -0
- package/dist/cjs/src/client/billing.cjs +375 -0
- package/dist/cjs/src/client/billing.cjs.map +1 -0
- package/dist/cjs/src/client/billing.d.cts +563 -0
- package/dist/cjs/src/client/common.cjs +47 -0
- package/dist/cjs/src/client/common.cjs.map +1 -0
- package/dist/cjs/src/client/common.d.cts +30 -0
- package/dist/cjs/src/client/customers.cjs +469 -0
- package/dist/cjs/src/client/customers.cjs.map +1 -0
- package/dist/cjs/src/client/customers.d.cts +620 -0
- package/dist/cjs/src/client/debug.cjs +27 -0
- package/dist/cjs/src/client/debug.cjs.map +1 -0
- package/dist/cjs/src/client/debug.d.cts +17 -0
- package/dist/cjs/src/client/entitlements.cjs +372 -0
- package/dist/cjs/src/client/entitlements.cjs.map +1 -0
- package/dist/cjs/src/client/entitlements.d.cts +670 -0
- package/dist/cjs/src/client/events.cjs +113 -0
- package/dist/cjs/src/client/events.cjs.map +1 -0
- package/dist/cjs/src/client/events.d.cts +48 -0
- package/dist/cjs/src/client/features.cjs +78 -0
- package/dist/cjs/src/client/features.cjs.map +1 -0
- package/dist/cjs/src/client/features.d.cts +90 -0
- package/dist/cjs/src/client/index.cjs +122 -0
- package/dist/cjs/src/client/index.cjs.map +1 -0
- package/dist/cjs/src/client/index.d.cts +54 -0
- package/dist/cjs/src/client/info.cjs +42 -0
- package/dist/cjs/src/client/info.cjs.map +1 -0
- package/dist/cjs/src/client/info.d.cts +34 -0
- package/dist/cjs/src/client/meters.cjs +160 -0
- package/dist/cjs/src/client/meters.cjs.map +1 -0
- package/dist/cjs/src/client/meters.d.cts +220 -0
- package/dist/cjs/src/client/notifications.cjs +269 -0
- package/dist/cjs/src/client/notifications.cjs.map +1 -0
- package/dist/cjs/src/client/notifications.d.cts +412 -0
- package/dist/cjs/src/client/plans.cjs +204 -0
- package/dist/cjs/src/client/plans.cjs.map +1 -0
- package/dist/cjs/src/client/plans.d.cts +252 -0
- package/dist/cjs/src/client/portal.cjs +55 -0
- package/dist/cjs/src/client/portal.cjs.map +1 -0
- package/dist/cjs/src/client/portal.d.cts +48 -0
- package/dist/cjs/src/client/schemas.cjs +3 -0
- package/dist/cjs/src/client/schemas.cjs.map +1 -0
- package/dist/cjs/src/client/schemas.d.cts +28002 -0
- package/dist/cjs/src/client/subjects.cjs +76 -0
- package/dist/cjs/src/client/subjects.cjs.map +1 -0
- package/dist/cjs/src/client/subjects.d.cts +79 -0
- package/dist/cjs/src/client/subscription-addons.cjs +70 -0
- package/dist/cjs/src/client/subscription-addons.cjs.map +1 -0
- package/dist/cjs/src/client/subscription-addons.d.cts +123 -0
- package/dist/cjs/src/client/subscriptions.cjs +132 -0
- package/dist/cjs/src/client/subscriptions.cjs.map +1 -0
- package/dist/cjs/src/client/subscriptions.d.cts +180 -0
- package/dist/cjs/src/client/utils.cjs +67 -0
- package/dist/cjs/src/client/utils.cjs.map +1 -0
- package/dist/cjs/src/client/utils.d.cts +12 -0
- package/dist/cjs/src/portal/index.cjs +89 -0
- package/dist/cjs/src/portal/index.cjs.map +1 -0
- package/dist/cjs/src/portal/index.d.cts +43 -0
- package/dist/cjs/src/react/context.cjs +35 -0
- package/dist/cjs/src/react/context.cjs.map +1 -0
- package/dist/cjs/src/react/context.d.cts +9 -0
- package/dist/cjs/src/zod/index.cjs +13679 -0
- package/dist/cjs/src/zod/index.cjs.map +1 -0
- package/dist/cjs/src/zod/index.d.cts +6360 -0
- package/dist/index.d.ts +1 -14
- package/dist/index.js +2 -15
- package/dist/index.js.map +1 -0
- package/dist/src/client/addons.d.ts +152 -0
- package/dist/src/client/addons.js +101 -0
- package/dist/src/client/addons.js.map +1 -0
- package/dist/src/client/apps.d.ts +327 -0
- package/dist/src/client/apps.js +240 -0
- package/dist/src/client/apps.js.map +1 -0
- package/dist/src/client/billing.d.ts +563 -0
- package/dist/src/client/billing.js +368 -0
- package/dist/src/client/billing.js.map +1 -0
- package/dist/src/client/common.d.ts +30 -0
- package/dist/src/client/common.js +42 -0
- package/dist/src/client/common.js.map +1 -0
- package/dist/src/client/customers.d.ts +620 -0
- package/dist/src/client/customers.js +461 -0
- package/dist/src/client/customers.js.map +1 -0
- package/dist/src/client/debug.d.ts +17 -0
- package/dist/src/client/debug.js +23 -0
- package/dist/src/client/debug.js.map +1 -0
- package/dist/src/client/entitlements.d.ts +670 -0
- package/dist/src/client/entitlements.js +365 -0
- package/dist/src/client/entitlements.js.map +1 -0
- package/dist/src/client/events.d.ts +48 -0
- package/dist/src/client/events.js +108 -0
- package/dist/src/client/events.js.map +1 -0
- package/dist/src/client/features.d.ts +90 -0
- package/dist/src/client/features.js +74 -0
- package/dist/src/client/features.js.map +1 -0
- package/dist/src/client/index.d.ts +54 -0
- package/dist/src/client/index.js +82 -0
- package/dist/src/client/index.js.map +1 -0
- package/dist/src/client/info.d.ts +34 -0
- package/dist/src/client/info.js +38 -0
- package/dist/src/client/info.js.map +1 -0
- package/dist/src/client/meters.d.ts +220 -0
- package/dist/src/client/meters.js +156 -0
- package/dist/src/client/meters.js.map +1 -0
- package/dist/src/client/notifications.d.ts +412 -0
- package/dist/src/client/notifications.js +262 -0
- package/dist/src/client/notifications.js.map +1 -0
- package/dist/src/client/plans.d.ts +252 -0
- package/dist/src/client/plans.js +199 -0
- package/dist/src/client/plans.js.map +1 -0
- package/dist/src/client/portal.d.ts +48 -0
- package/dist/src/client/portal.js +51 -0
- package/dist/src/client/portal.js.map +1 -0
- package/dist/src/client/schemas.d.ts +28002 -0
- package/dist/src/client/schemas.js +2 -0
- package/dist/src/client/schemas.js.map +1 -0
- package/dist/src/client/subjects.d.ts +79 -0
- package/dist/src/client/subjects.js +72 -0
- package/dist/src/client/subjects.js.map +1 -0
- package/dist/src/client/subscription-addons.d.ts +123 -0
- package/dist/src/client/subscription-addons.js +66 -0
- package/dist/src/client/subscription-addons.js.map +1 -0
- package/dist/src/client/subscriptions.d.ts +180 -0
- package/dist/src/client/subscriptions.js +128 -0
- package/dist/src/client/subscriptions.js.map +1 -0
- package/dist/src/client/utils.d.ts +12 -0
- package/dist/src/client/utils.js +61 -0
- package/dist/src/client/utils.js.map +1 -0
- package/dist/src/portal/index.d.ts +43 -0
- package/dist/src/portal/index.js +52 -0
- package/dist/src/portal/index.js.map +1 -0
- package/dist/src/react/context.d.ts +9 -0
- package/dist/src/react/context.js +16 -0
- package/dist/src/react/context.js.map +1 -0
- package/dist/src/zod/index.d.ts +6360 -0
- package/dist/src/zod/index.js +13615 -0
- package/dist/src/zod/index.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +82 -40
- package/dist/clients/client.d.ts +0 -40
- package/dist/clients/client.js +0 -104
- package/dist/clients/event.d.ts +0 -79
- package/dist/clients/event.js +0 -53
- package/dist/clients/meter.d.ts +0 -71
- package/dist/clients/meter.js +0 -64
- package/dist/clients/portal.d.ts +0 -23
- package/dist/clients/portal.js +0 -37
- package/dist/next.d.ts +0 -15
- package/dist/next.js +0 -46
- package/dist/schemas/openapi.d.ts +0 -460
- package/dist/schemas/openapi.js +0 -5
- package/dist/test/agent.d.ts +0 -2
- package/dist/test/agent.js +0 -178
- package/dist/test/mocks.d.ts +0 -12
- package/dist/test/mocks.js +0 -32
- package/index.ts +0 -22
- package/next.ts +0 -76
|
@@ -0,0 +1,461 @@
|
|
|
1
|
+
import { transformResponse } from './utils.js';
|
|
2
|
+
/**
|
|
3
|
+
* Customers
|
|
4
|
+
* Manage customer subscription lifecycles and plan assignments.
|
|
5
|
+
*/
|
|
6
|
+
export class Customers {
|
|
7
|
+
client;
|
|
8
|
+
apps;
|
|
9
|
+
entitlementsV1;
|
|
10
|
+
entitlements;
|
|
11
|
+
stripe;
|
|
12
|
+
constructor(client) {
|
|
13
|
+
this.client = client;
|
|
14
|
+
this.apps = new CustomerApps(client);
|
|
15
|
+
this.entitlementsV1 = new CustomerEntitlements(client);
|
|
16
|
+
this.entitlements = new CustomerEntitlementsV2(client);
|
|
17
|
+
this.stripe = new CustomerStripe(client);
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Create a customer
|
|
21
|
+
* @param customer - The customer to create
|
|
22
|
+
* @param signal - An optional abort signal
|
|
23
|
+
* @returns The created customer
|
|
24
|
+
*/
|
|
25
|
+
async create(customer, options) {
|
|
26
|
+
const resp = await this.client.POST('/api/v1/customers', {
|
|
27
|
+
body: customer,
|
|
28
|
+
...options,
|
|
29
|
+
});
|
|
30
|
+
return transformResponse(resp);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Get a customer by ID
|
|
34
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
35
|
+
* @param signal - An optional abort signal
|
|
36
|
+
* @returns The customer
|
|
37
|
+
*/
|
|
38
|
+
async get(customerIdOrKey, options) {
|
|
39
|
+
const resp = await this.client.GET('/api/v1/customers/{customerIdOrKey}', {
|
|
40
|
+
params: {
|
|
41
|
+
path: {
|
|
42
|
+
customerIdOrKey,
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
...options,
|
|
46
|
+
});
|
|
47
|
+
return transformResponse(resp);
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Update a customer
|
|
51
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
52
|
+
* @param customer - The customer to update
|
|
53
|
+
* @param signal - An optional abort signal
|
|
54
|
+
* @returns The updated customer
|
|
55
|
+
*/
|
|
56
|
+
async update(customerIdOrKey, customer, options) {
|
|
57
|
+
const resp = await this.client.PUT('/api/v1/customers/{customerIdOrKey}', {
|
|
58
|
+
body: customer,
|
|
59
|
+
params: {
|
|
60
|
+
path: {
|
|
61
|
+
customerIdOrKey,
|
|
62
|
+
},
|
|
63
|
+
},
|
|
64
|
+
...options,
|
|
65
|
+
});
|
|
66
|
+
return transformResponse(resp);
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Delete a customer
|
|
70
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
71
|
+
* @param signal - An optional abort signal
|
|
72
|
+
* @returns The deleted customer
|
|
73
|
+
*/
|
|
74
|
+
async delete(customerIdOrKey, options) {
|
|
75
|
+
const resp = await this.client.DELETE('/api/v1/customers/{customerIdOrKey}', {
|
|
76
|
+
params: {
|
|
77
|
+
path: {
|
|
78
|
+
customerIdOrKey,
|
|
79
|
+
},
|
|
80
|
+
},
|
|
81
|
+
...options,
|
|
82
|
+
});
|
|
83
|
+
return transformResponse(resp);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* List customers
|
|
87
|
+
* @param signal - An optional abort signal
|
|
88
|
+
* @returns The list of customers
|
|
89
|
+
*/
|
|
90
|
+
async list(query, options) {
|
|
91
|
+
const resp = await this.client.GET('/api/v1/customers', {
|
|
92
|
+
params: {
|
|
93
|
+
query,
|
|
94
|
+
},
|
|
95
|
+
...options,
|
|
96
|
+
});
|
|
97
|
+
return transformResponse(resp);
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Get customer access
|
|
101
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
102
|
+
* @param options - Optional request options
|
|
103
|
+
* @returns The customer access information
|
|
104
|
+
*/
|
|
105
|
+
async getAccess(customerIdOrKey, options) {
|
|
106
|
+
const resp = await this.client.GET('/api/v1/customers/{customerIdOrKey}/access', {
|
|
107
|
+
params: {
|
|
108
|
+
path: {
|
|
109
|
+
customerIdOrKey,
|
|
110
|
+
},
|
|
111
|
+
},
|
|
112
|
+
...options,
|
|
113
|
+
});
|
|
114
|
+
return transformResponse(resp);
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* List customer subscriptions
|
|
118
|
+
* @param customerIdOrKey - The ID or key of the customer
|
|
119
|
+
* @param query - The query parameters
|
|
120
|
+
* @param signal - An optional abort signal
|
|
121
|
+
* @returns The list of customer subscriptions
|
|
122
|
+
*/
|
|
123
|
+
async listSubscriptions(customerIdOrKey, query, options) {
|
|
124
|
+
const resp = await this.client.GET('/api/v1/customers/{customerIdOrKey}/subscriptions', {
|
|
125
|
+
params: { path: { customerIdOrKey }, query },
|
|
126
|
+
...options,
|
|
127
|
+
});
|
|
128
|
+
return transformResponse(resp);
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* Customer Apps
|
|
133
|
+
* Manage customer apps.
|
|
134
|
+
*/
|
|
135
|
+
export class CustomerApps {
|
|
136
|
+
client;
|
|
137
|
+
constructor(client) {
|
|
138
|
+
this.client = client;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Upsert customer app data
|
|
142
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
143
|
+
* @param appData - The app data to upsert
|
|
144
|
+
* @param signal - An optional abort signal
|
|
145
|
+
* @returns The upserted app data
|
|
146
|
+
*/
|
|
147
|
+
async upsert(customerIdOrKey, appData, options) {
|
|
148
|
+
const resp = await this.client.PUT('/api/v1/customers/{customerIdOrKey}/apps', {
|
|
149
|
+
body: appData,
|
|
150
|
+
params: {
|
|
151
|
+
path: {
|
|
152
|
+
customerIdOrKey,
|
|
153
|
+
},
|
|
154
|
+
},
|
|
155
|
+
...options,
|
|
156
|
+
});
|
|
157
|
+
return transformResponse(resp);
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* List customer app data
|
|
161
|
+
* @param customerIdOrKey - The ID or key of the customer
|
|
162
|
+
* @param query - The query parameters
|
|
163
|
+
* @param signal - An optional abort signal
|
|
164
|
+
* @returns The list of customer app data
|
|
165
|
+
*/
|
|
166
|
+
async list(customerIdOrKey, query, options) {
|
|
167
|
+
const resp = await this.client.GET('/api/v1/customers/{customerIdOrKey}/apps', {
|
|
168
|
+
params: {
|
|
169
|
+
path: { customerIdOrKey },
|
|
170
|
+
query,
|
|
171
|
+
},
|
|
172
|
+
...options,
|
|
173
|
+
});
|
|
174
|
+
return transformResponse(resp);
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Delete customer app data
|
|
178
|
+
* @param customerIdOrKey - The ID or key of the customer
|
|
179
|
+
* @param appId - The ID of the app
|
|
180
|
+
* @param signal - An optional abort signal
|
|
181
|
+
* @returns The deleted customer app data
|
|
182
|
+
*/
|
|
183
|
+
async delete(customerIdOrKey, appId, options) {
|
|
184
|
+
const resp = await this.client.DELETE('/api/v1/customers/{customerIdOrKey}/apps/{appId}', {
|
|
185
|
+
params: { path: { appId, customerIdOrKey } },
|
|
186
|
+
...options,
|
|
187
|
+
});
|
|
188
|
+
return transformResponse(resp);
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Customer Stripe
|
|
193
|
+
* Manage customer Stripe data.
|
|
194
|
+
*/
|
|
195
|
+
export class CustomerStripe {
|
|
196
|
+
client;
|
|
197
|
+
constructor(client) {
|
|
198
|
+
this.client = client;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* Upsert customer stripe app data
|
|
202
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
203
|
+
* @param appData - The app data to upsert
|
|
204
|
+
* @param signal - An optional abort signal
|
|
205
|
+
* @returns The upserted customer stripe app data
|
|
206
|
+
*/
|
|
207
|
+
async upsert(customerIdOrKey, stripeAppData, options) {
|
|
208
|
+
const resp = await this.client.PUT('/api/v1/customers/{customerIdOrKey}/stripe', {
|
|
209
|
+
body: stripeAppData,
|
|
210
|
+
params: {
|
|
211
|
+
path: {
|
|
212
|
+
customerIdOrKey,
|
|
213
|
+
},
|
|
214
|
+
},
|
|
215
|
+
...options,
|
|
216
|
+
});
|
|
217
|
+
return transformResponse(resp);
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* Get customer stripe app data
|
|
221
|
+
* @param customerIdOrKey - The ID or key of the customer
|
|
222
|
+
* @param query - The query parameters
|
|
223
|
+
* @param signal - An optional abort signal
|
|
224
|
+
* @returns The customer stripe app data
|
|
225
|
+
*/
|
|
226
|
+
async get(customerIdOrKey, options) {
|
|
227
|
+
const resp = await this.client.GET('/api/v1/customers/{customerIdOrKey}/stripe', {
|
|
228
|
+
params: {
|
|
229
|
+
path: { customerIdOrKey },
|
|
230
|
+
},
|
|
231
|
+
...options,
|
|
232
|
+
});
|
|
233
|
+
return transformResponse(resp);
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* Create a Stripe customer portal session
|
|
237
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
238
|
+
* @param params - The parameters for creating a Stripe customer portal session
|
|
239
|
+
* @param signal - An optional abort signal
|
|
240
|
+
* @returns The Stripe customer portal session
|
|
241
|
+
*/
|
|
242
|
+
async createPortalSession(customerIdOrKey, params, options) {
|
|
243
|
+
const resp = await this.client.POST('/api/v1/customers/{customerIdOrKey}/stripe/portal', {
|
|
244
|
+
body: params,
|
|
245
|
+
params: {
|
|
246
|
+
path: {
|
|
247
|
+
customerIdOrKey,
|
|
248
|
+
},
|
|
249
|
+
},
|
|
250
|
+
...options,
|
|
251
|
+
});
|
|
252
|
+
return transformResponse(resp);
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* Customer Entitlements
|
|
257
|
+
*/
|
|
258
|
+
export class CustomerEntitlements {
|
|
259
|
+
client;
|
|
260
|
+
constructor(client) {
|
|
261
|
+
this.client = client;
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* Get the value of an entitlement for a customer
|
|
265
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
266
|
+
* @param featureKey - The key of the feature
|
|
267
|
+
* @param signal - An optional abort signal
|
|
268
|
+
* @returns The value of the entitlement
|
|
269
|
+
*/
|
|
270
|
+
async value(customerIdOrKey, featureKey, options) {
|
|
271
|
+
const resp = await this.client.GET('/api/v1/customers/{customerIdOrKey}/entitlements/{featureKey}/value', {
|
|
272
|
+
params: { path: { customerIdOrKey, featureKey } },
|
|
273
|
+
...options,
|
|
274
|
+
});
|
|
275
|
+
return transformResponse(resp);
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* Customer Entitlements V2
|
|
280
|
+
*/
|
|
281
|
+
export class CustomerEntitlementsV2 {
|
|
282
|
+
client;
|
|
283
|
+
constructor(client) {
|
|
284
|
+
this.client = client;
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* List all entitlements for a customer
|
|
288
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
289
|
+
* @param options - Request options including query parameters
|
|
290
|
+
* @returns List of customer entitlements
|
|
291
|
+
*/
|
|
292
|
+
async list(customerIdOrKey, options) {
|
|
293
|
+
const resp = await this.client.GET('/api/v2/customers/{customerIdOrKey}/entitlements', {
|
|
294
|
+
params: {
|
|
295
|
+
path: { customerIdOrKey },
|
|
296
|
+
query: options?.query,
|
|
297
|
+
},
|
|
298
|
+
...options,
|
|
299
|
+
});
|
|
300
|
+
return transformResponse(resp);
|
|
301
|
+
}
|
|
302
|
+
/**
|
|
303
|
+
* Create a customer entitlement
|
|
304
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
305
|
+
* @param entitlement - The entitlement data to create
|
|
306
|
+
* @param options - Request options
|
|
307
|
+
* @returns The created entitlement
|
|
308
|
+
*/
|
|
309
|
+
async create(customerIdOrKey, entitlement, options) {
|
|
310
|
+
const resp = await this.client.POST('/api/v2/customers/{customerIdOrKey}/entitlements', {
|
|
311
|
+
body: entitlement,
|
|
312
|
+
params: {
|
|
313
|
+
path: { customerIdOrKey },
|
|
314
|
+
},
|
|
315
|
+
...options,
|
|
316
|
+
});
|
|
317
|
+
return transformResponse(resp);
|
|
318
|
+
}
|
|
319
|
+
/**
|
|
320
|
+
* Get a specific customer entitlement
|
|
321
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
322
|
+
* @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
|
|
323
|
+
* @param options - Request options
|
|
324
|
+
* @returns The entitlement
|
|
325
|
+
*/
|
|
326
|
+
async get(customerIdOrKey, entitlementIdOrFeatureKey, options) {
|
|
327
|
+
const resp = await this.client.GET('/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}', {
|
|
328
|
+
params: {
|
|
329
|
+
path: { customerIdOrKey, entitlementIdOrFeatureKey },
|
|
330
|
+
},
|
|
331
|
+
...options,
|
|
332
|
+
});
|
|
333
|
+
return transformResponse(resp);
|
|
334
|
+
}
|
|
335
|
+
/**
|
|
336
|
+
* Delete a customer entitlement
|
|
337
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
338
|
+
* @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
|
|
339
|
+
* @param options - Request options
|
|
340
|
+
* @returns The deletion response
|
|
341
|
+
*/
|
|
342
|
+
async delete(customerIdOrKey, entitlementIdOrFeatureKey, options) {
|
|
343
|
+
const resp = await this.client.DELETE('/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}', {
|
|
344
|
+
params: {
|
|
345
|
+
path: { customerIdOrKey, entitlementIdOrFeatureKey },
|
|
346
|
+
},
|
|
347
|
+
...options,
|
|
348
|
+
});
|
|
349
|
+
return transformResponse(resp);
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* Override a customer entitlement
|
|
353
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
354
|
+
* @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
|
|
355
|
+
* @param entitlement - The new entitlement data
|
|
356
|
+
* @param options - Request options
|
|
357
|
+
* @returns The overridden entitlement
|
|
358
|
+
*/
|
|
359
|
+
async override(customerIdOrKey, entitlementIdOrFeatureKey, entitlement, options) {
|
|
360
|
+
const resp = await this.client.PUT('/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override', {
|
|
361
|
+
body: entitlement,
|
|
362
|
+
params: {
|
|
363
|
+
path: { customerIdOrKey, entitlementIdOrFeatureKey },
|
|
364
|
+
},
|
|
365
|
+
...options,
|
|
366
|
+
});
|
|
367
|
+
return transformResponse(resp);
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* List grants for a customer entitlement
|
|
371
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
372
|
+
* @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
|
|
373
|
+
* @param options - Request options including query parameters
|
|
374
|
+
* @returns List of entitlement grants
|
|
375
|
+
*/
|
|
376
|
+
async listGrants(customerIdOrKey, entitlementIdOrFeatureKey, options) {
|
|
377
|
+
const resp = await this.client.GET('/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants', {
|
|
378
|
+
params: {
|
|
379
|
+
path: { customerIdOrKey, entitlementIdOrFeatureKey },
|
|
380
|
+
query: options?.query,
|
|
381
|
+
},
|
|
382
|
+
...options,
|
|
383
|
+
});
|
|
384
|
+
return transformResponse(resp);
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* Create a grant for a customer entitlement
|
|
388
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
389
|
+
* @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
|
|
390
|
+
* @param grant - The grant data to create
|
|
391
|
+
* @param options - Request options
|
|
392
|
+
* @returns The created grant
|
|
393
|
+
*/
|
|
394
|
+
async createGrant(customerIdOrKey, entitlementIdOrFeatureKey, grant, options) {
|
|
395
|
+
const resp = await this.client.POST('/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants', {
|
|
396
|
+
body: grant,
|
|
397
|
+
params: {
|
|
398
|
+
path: { customerIdOrKey, entitlementIdOrFeatureKey },
|
|
399
|
+
},
|
|
400
|
+
...options,
|
|
401
|
+
});
|
|
402
|
+
return transformResponse(resp);
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* Get the value of a customer entitlement
|
|
406
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
407
|
+
* @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
|
|
408
|
+
* @param options - Request options including query parameters
|
|
409
|
+
* @returns The entitlement value
|
|
410
|
+
*/
|
|
411
|
+
async value(customerIdOrKey, entitlementIdOrFeatureKey, options) {
|
|
412
|
+
const resp = await this.client.GET('/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value', {
|
|
413
|
+
params: {
|
|
414
|
+
path: { customerIdOrKey, entitlementIdOrFeatureKey },
|
|
415
|
+
query: options?.query,
|
|
416
|
+
},
|
|
417
|
+
...options,
|
|
418
|
+
});
|
|
419
|
+
return transformResponse(resp);
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* Get the history of a customer entitlement
|
|
423
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
424
|
+
* @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
|
|
425
|
+
* @param windowSize - The window size for the history
|
|
426
|
+
* @param options - Request options including query parameters
|
|
427
|
+
* @returns The entitlement history
|
|
428
|
+
*/
|
|
429
|
+
async history(customerIdOrKey, entitlementIdOrFeatureKey, windowSize, options) {
|
|
430
|
+
const resp = await this.client.GET('/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history', {
|
|
431
|
+
params: {
|
|
432
|
+
path: { customerIdOrKey, entitlementIdOrFeatureKey },
|
|
433
|
+
query: {
|
|
434
|
+
windowSize,
|
|
435
|
+
...options?.query,
|
|
436
|
+
},
|
|
437
|
+
},
|
|
438
|
+
...options,
|
|
439
|
+
});
|
|
440
|
+
return transformResponse(resp);
|
|
441
|
+
}
|
|
442
|
+
/**
|
|
443
|
+
* Reset the usage of a customer entitlement
|
|
444
|
+
* @param customerIdOrKey - The ID or Key of the customer
|
|
445
|
+
* @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
|
|
446
|
+
* @param reset - The reset data
|
|
447
|
+
* @param options - Request options
|
|
448
|
+
* @returns The reset response
|
|
449
|
+
*/
|
|
450
|
+
async resetUsage(customerIdOrKey, entitlementIdOrFeatureKey, reset, options) {
|
|
451
|
+
const resp = await this.client.POST('/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset', {
|
|
452
|
+
body: reset,
|
|
453
|
+
params: {
|
|
454
|
+
path: { customerIdOrKey, entitlementIdOrFeatureKey },
|
|
455
|
+
},
|
|
456
|
+
...options,
|
|
457
|
+
});
|
|
458
|
+
return transformResponse(resp);
|
|
459
|
+
}
|
|
460
|
+
}
|
|
461
|
+
//# sourceMappingURL=customers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../../src/client/customers.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAE9C;;;GAGG;AACH,MAAM,OAAO,SAAS;IAMA;IALb,IAAI,CAAc;IAClB,cAAc,CAAsB;IACpC,YAAY,CAAwB;IACpC,MAAM,CAAgB;IAE7B,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;QAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAA;QACtD,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAAA;QACtD,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,QAAwB,EAAE,OAAwB;QACpE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE;YACvD,IAAI,EAAE,QAAQ;YACd,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,eAAmF,EACnF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACxE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAAsF,EACtF,QAA+B,EAC/B,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACxE,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CACjB,eAAsF,EACtF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,qCAAqC,EACrC;YACE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CACf,KAA0D,EAC1D,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACtD,MAAM,EAAE;gBACN,KAAK;aACN;YACD,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,eAAyF,EACzF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,4CAA4C,EAC5C;YACE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAC5B,eAAiG,EACjG,KAAsE,EACtE,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,mDAAmD,EACnD;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE;YAC5C,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,YAAY;IACH;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAA6F,EAC7F,OAA0B,EAC1B,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,0CAA0C,EAC1C;YACE,IAAI,EAAE,OAAO;YACb,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CACf,eAA2F,EAC3F,KAAgE,EAChE,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,0CAA0C,EAC1C;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE;gBACzB,KAAK;aACN;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAA6F,EAC7F,KAAyE,EACzE,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,kDAAkD,EAClD;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,EAAE;YAC5C,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,cAAc;IACL;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAAmG,EACnG,aAAwC,EACxC,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,4CAA4C,EAC5C;YACE,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,eAAgG,EAChG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,4CAA4C,EAC5C;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE;aAC1B;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,mBAAmB,CAC9B,eAAyG,EACzG,MAA+C,EAC/C,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,mDAAmD,EACnD;YACE,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,eAAe;iBAChB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,oBAAoB;IACX;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAChB,eAAmG,EACnG,UAAyF,EACzF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,qEAAqE,EACrE;YACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE;YACjD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,sBAAsB;IACb;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,eAAkG,EAClG,OAEC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,kDAAkD,EAClD;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE;gBACzB,KAAK,EAAE,OAAO,EAAE,KAAK;aACtB;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAAmG,EACnG,WAAoG,EACpG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,kDAAkD,EAClD;YACE,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE;aAC1B;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,eAAgG,EAChG,yBAAoH,EACpH,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,8EAA8E,EAC9E;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,eAAmG,EACnG,yBAAuH,EACvH,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CACnC,8EAA8E,EAC9E;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,QAAQ,CACnB,eAAqG,EACrG,yBAAyH,EACzH,WAAsG,EACtG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,uFAAuF,EACvF;YACE,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CACrB,eAAuG,EACvG,yBAA2H,EAC3H,OAEC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,qFAAqF,EACrF;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;gBACpD,KAAK,EAAE,OAAO,EAAE,KAAK;aACtB;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,WAAW,CACtB,eAAwG,EACxG,yBAA4H,EAC5H,KAAmG,EACnG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,qFAAqF,EACrF;YACE,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAChB,eAAqG,EACrG,yBAAyH,EACzH,OAEC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,oFAAoF,EACpF;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;gBACpD,KAAK,EAAE,OAAO,EAAE,KAAK;aACtB;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CAClB,eAAuG,EACvG,yBAA2H,EAC3H,UAA8F,EAC9F,OAKC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,sFAAsF,EACtF;YACE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;gBACpD,KAAK,EAAE;oBACL,UAAU;oBACV,GAAG,OAAO,EAAE,KAAK;iBAClB;aACF;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,UAAU,CACrB,eAAuG,EACvG,yBAA2H,EAC3H,KAAkG,EAClG,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACjC,oFAAoF,EACpF;YACE,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,eAAe,EAAE,yBAAyB,EAAE;aACrD;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { Client } from 'openapi-fetch';
|
|
2
|
+
import type { RequestOptions } from './common.js';
|
|
3
|
+
import type { paths } from './schemas.js';
|
|
4
|
+
/**
|
|
5
|
+
* Debug utilities for OpenMeter
|
|
6
|
+
*/
|
|
7
|
+
export declare class Debug {
|
|
8
|
+
private client;
|
|
9
|
+
constructor(client: Client<paths, `${string}/${string}`>);
|
|
10
|
+
/**
|
|
11
|
+
* Get event metrics
|
|
12
|
+
* @description Returns debug metrics (in OpenMetrics format) like the number of ingested events since mindnight UTC.
|
|
13
|
+
* @param options - The request options
|
|
14
|
+
* @returns The debug metrics
|
|
15
|
+
*/
|
|
16
|
+
getMetrics(options?: RequestOptions): Promise<string | undefined>;
|
|
17
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { transformResponse } from './utils.js';
|
|
2
|
+
/**
|
|
3
|
+
* Debug utilities for OpenMeter
|
|
4
|
+
*/
|
|
5
|
+
export class Debug {
|
|
6
|
+
client;
|
|
7
|
+
constructor(client) {
|
|
8
|
+
this.client = client;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Get event metrics
|
|
12
|
+
* @description Returns debug metrics (in OpenMetrics format) like the number of ingested events since mindnight UTC.
|
|
13
|
+
* @param options - The request options
|
|
14
|
+
* @returns The debug metrics
|
|
15
|
+
*/
|
|
16
|
+
async getMetrics(options) {
|
|
17
|
+
const resp = await this.client.GET('/api/v1/debug/metrics', {
|
|
18
|
+
...options,
|
|
19
|
+
});
|
|
20
|
+
return transformResponse(resp);
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=debug.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"debug.js","sourceRoot":"","sources":["../../../src/client/debug.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAE9C;;GAEG;AACH,MAAM,OAAO,KAAK;IACI;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CAAC,OAAwB;QAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE;YAC1D,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF"}
|