@openmeter/client 1.0.0-beta.235 → 1.0.0-beta.236
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 +22 -0
- package/dist/funcs/apps.d.ts +10 -1
- package/dist/funcs/apps.js +40 -0
- package/dist/funcs/notifications.d.ts +79 -1
- package/dist/funcs/notifications.js +296 -0
- package/dist/index.d.ts +1 -1
- package/dist/lib/version.d.ts +1 -1
- package/dist/lib/version.js +1 -1
- package/dist/models/operations/apps.d.ts +6 -1
- package/dist/models/operations/notifications.d.ts +92 -1
- package/dist/models/schemas.d.ts +5907 -1137
- package/dist/models/schemas.js +1147 -9
- package/dist/models/types.d.ts +770 -3
- package/dist/sdk/internal.d.ts +122 -0
- package/dist/sdk/internal.js +154 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -42,6 +42,8 @@ TypeSpec definitions and ships fully-typed request and response models.
|
|
|
42
42
|
- [Notifications](#notifications)
|
|
43
43
|
- [Internal Operations](#internal-operations)
|
|
44
44
|
- [Internal Subscriptions](#internal-subscriptions)
|
|
45
|
+
- [Internal Apps](#internal-apps)
|
|
46
|
+
- [Internal Notifications](#internal-notifications)
|
|
45
47
|
- [Runtime Validation (validate option)](#runtime-validation-validate-option)
|
|
46
48
|
- [Zod Schemas (./zod export)](#zod-schemas-zod-export)
|
|
47
49
|
- [Error Handling](#error-handling)
|
|
@@ -502,6 +504,26 @@ they can change or be removed without notice or semver consideration.
|
|
|
502
504
|
| `client.internal.subscriptions.createAddon` | `POST /openmeter/subscriptions/{subscriptionId}/addons` | Add add-on to a subscription. |
|
|
503
505
|
| `client.internal.subscriptions.updateAddon` | `PATCH /openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}` | Update a subscription add-on. Only the quantity is mutable; the timing controls when the new quantity takes effect. A new entry is appended to the add-on's timeline. |
|
|
504
506
|
|
|
507
|
+
### Internal Apps
|
|
508
|
+
|
|
509
|
+
| Method | HTTP | Description |
|
|
510
|
+
| ------------------------------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
|
511
|
+
| `client.internal.apps.executeAction` | `POST /openmeter/apps/{appId}/action` | Execute an operator action on an installed app. The action must be listed in the app's `actions`; otherwise the request is rejected. |
|
|
512
|
+
|
|
513
|
+
### Internal Notifications
|
|
514
|
+
|
|
515
|
+
| Method | HTTP | Description |
|
|
516
|
+
| ------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
517
|
+
| `client.internal.notifications.listRules` | `GET /openmeter/notification/rules` | List all notification rules. |
|
|
518
|
+
| `client.internal.notifications.createRule` | `POST /openmeter/notification/rules` | Create a notification rule. |
|
|
519
|
+
| `client.internal.notifications.getRule` | `GET /openmeter/notification/rules/{notificationRuleId}` | Get a notification rule by id. |
|
|
520
|
+
| `client.internal.notifications.updateRule` | `PUT /openmeter/notification/rules/{notificationRuleId}` | Update a notification rule by id. |
|
|
521
|
+
| `client.internal.notifications.deleteRule` | `DELETE /openmeter/notification/rules/{notificationRuleId}` | Delete a notification rule by id. |
|
|
522
|
+
| `client.internal.notifications.testRule` | `POST /openmeter/notification/rules/{notificationRuleId}/test` | Test a notification rule by generating an event with sample data and delivering it to the rule's channels. The test event is persisted and listed like any other event. |
|
|
523
|
+
| `client.internal.notifications.listEvents` | `GET /openmeter/notification/events` | List all notification events. |
|
|
524
|
+
| `client.internal.notifications.getEvent` | `GET /openmeter/notification/events/{notificationEventId}` | Get a notification event by id. |
|
|
525
|
+
| `client.internal.notifications.resendEvent` | `POST /openmeter/notification/events/{notificationEventId}/resend` | Resend a notification event to the channels of the rule that generated it. Delivery is asynchronous: the request marks the selected channels for redelivery and returns immediately. Channels whose delivery is still pending or already being resent are left untouched. |
|
|
526
|
+
|
|
505
527
|
## Runtime Validation (validate option)
|
|
506
528
|
|
|
507
529
|
`validate` is off by default. The SDK's normal request/response mapping
|
package/dist/funcs/apps.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type Client } from '../core.js';
|
|
2
2
|
import { type Result, type RequestOptions } from '../lib/types.js';
|
|
3
|
-
import type { ListAppsRequest, ListAppsResponse, GetAppRequest, GetAppResponse, UninstallAppRequest, UninstallAppResponse, UpdateAppRequest, UpdateAppResponse, ListAppCatalogRequest, ListAppCatalogResponse, GetAppCatalogItemRequest, GetAppCatalogItemResponse, InstallAppRequest, InstallAppResponse } from '../models/operations/apps.js';
|
|
3
|
+
import type { ListAppsRequest, ListAppsResponse, GetAppRequest, GetAppResponse, UninstallAppRequest, UninstallAppResponse, UpdateAppRequest, UpdateAppResponse, ExecuteAppActionRequest, ExecuteAppActionResponse, ListAppCatalogRequest, ListAppCatalogResponse, GetAppCatalogItemRequest, GetAppCatalogItemResponse, InstallAppRequest, InstallAppResponse } from '../models/operations/apps.js';
|
|
4
4
|
/**
|
|
5
5
|
* List apps
|
|
6
6
|
*
|
|
@@ -33,6 +33,15 @@ export declare function uninstallApp(client: Client, req: UninstallAppRequest, o
|
|
|
33
33
|
* PUT /openmeter/apps/{appId}
|
|
34
34
|
*/
|
|
35
35
|
export declare function updateApp(client: Client, req: UpdateAppRequest, options?: RequestOptions): Promise<Result<UpdateAppResponse>>;
|
|
36
|
+
/**
|
|
37
|
+
* Execute app action
|
|
38
|
+
*
|
|
39
|
+
* Execute an operator action on an installed app. The action must be listed in the
|
|
40
|
+
* app's `actions`; otherwise the request is rejected.
|
|
41
|
+
*
|
|
42
|
+
* POST /openmeter/apps/{appId}/action
|
|
43
|
+
*/
|
|
44
|
+
export declare function executeAppAction(client: Client, req: ExecuteAppActionRequest, options?: RequestOptions): Promise<Result<ExecuteAppActionResponse>>;
|
|
36
45
|
/**
|
|
37
46
|
* List app catalog
|
|
38
47
|
*
|
package/dist/funcs/apps.js
CHANGED
|
@@ -137,6 +137,46 @@ export function updateApp(client, req, options) {
|
|
|
137
137
|
});
|
|
138
138
|
});
|
|
139
139
|
}
|
|
140
|
+
/**
|
|
141
|
+
* Execute app action
|
|
142
|
+
*
|
|
143
|
+
* Execute an operator action on an installed app. The action must be listed in the
|
|
144
|
+
* app's `actions`; otherwise the request is rejected.
|
|
145
|
+
*
|
|
146
|
+
* POST /openmeter/apps/{appId}/action
|
|
147
|
+
*/
|
|
148
|
+
export function executeAppAction(client, req, options) {
|
|
149
|
+
return request(() => {
|
|
150
|
+
const pathParamsInput = {
|
|
151
|
+
appId: req.appId,
|
|
152
|
+
};
|
|
153
|
+
const pathParams = client._options.validate
|
|
154
|
+
? toPathWire(pathParamsInput, schemas.executeAppActionPathParams)
|
|
155
|
+
: pathParamsInput;
|
|
156
|
+
if (client._options.validate) {
|
|
157
|
+
assertValid(schemas.executeAppActionPathParamsWire, pathParams);
|
|
158
|
+
}
|
|
159
|
+
const path = `openmeter/apps/${(() => {
|
|
160
|
+
if (pathParams.appId === undefined) {
|
|
161
|
+
throw new Error('missing path parameter: appId');
|
|
162
|
+
}
|
|
163
|
+
return encodeURIComponent(String(pathParams.appId));
|
|
164
|
+
})()}/action`;
|
|
165
|
+
const body = toWire(req.body, schemas.executeAppActionBody);
|
|
166
|
+
if (client._options.validate) {
|
|
167
|
+
assertValid(schemas.executeAppActionBodyWire, body);
|
|
168
|
+
}
|
|
169
|
+
return http(client)
|
|
170
|
+
.post(path, { ...options, json: body })
|
|
171
|
+
.json()
|
|
172
|
+
.then((data) => {
|
|
173
|
+
if (client._options.validate) {
|
|
174
|
+
assertValid(schemas.executeAppActionResponseWire, data);
|
|
175
|
+
}
|
|
176
|
+
return fromWire(data, schemas.executeAppActionResponse);
|
|
177
|
+
});
|
|
178
|
+
});
|
|
179
|
+
}
|
|
140
180
|
/**
|
|
141
181
|
* List app catalog
|
|
142
182
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type Client } from '../core.js';
|
|
2
2
|
import { type Result, type RequestOptions } from '../lib/types.js';
|
|
3
|
-
import type { ListNotificationChannelsRequest, ListNotificationChannelsResponse, CreateNotificationChannelRequest, CreateNotificationChannelResponse, GetNotificationChannelRequest, GetNotificationChannelResponse, UpdateNotificationChannelRequest, UpdateNotificationChannelResponse, DeleteNotificationChannelRequest, DeleteNotificationChannelResponse } from '../models/operations/notifications.js';
|
|
3
|
+
import type { ListNotificationChannelsRequest, ListNotificationChannelsResponse, CreateNotificationChannelRequest, CreateNotificationChannelResponse, GetNotificationChannelRequest, GetNotificationChannelResponse, UpdateNotificationChannelRequest, UpdateNotificationChannelResponse, DeleteNotificationChannelRequest, DeleteNotificationChannelResponse, ListNotificationRulesRequest, ListNotificationRulesResponse, CreateNotificationRuleRequest, CreateNotificationRuleResponse, GetNotificationRuleRequest, GetNotificationRuleResponse, UpdateNotificationRuleRequest, UpdateNotificationRuleResponse, DeleteNotificationRuleRequest, DeleteNotificationRuleResponse, TestNotificationRuleRequest, TestNotificationRuleResponse, ListNotificationEventsRequest, ListNotificationEventsResponse, GetNotificationEventRequest, GetNotificationEventResponse, ResendNotificationEventRequest, ResendNotificationEventResponse } from '../models/operations/notifications.js';
|
|
4
4
|
/**
|
|
5
5
|
* List notification channels
|
|
6
6
|
*
|
|
@@ -41,3 +41,81 @@ export declare function updateNotificationChannel(client: Client, req: UpdateNot
|
|
|
41
41
|
* DELETE /openmeter/notification/channels/{notificationChannelId}
|
|
42
42
|
*/
|
|
43
43
|
export declare function deleteNotificationChannel(client: Client, req: DeleteNotificationChannelRequest, options?: RequestOptions): Promise<Result<DeleteNotificationChannelResponse>>;
|
|
44
|
+
/**
|
|
45
|
+
* List notification rules
|
|
46
|
+
*
|
|
47
|
+
* List all notification rules.
|
|
48
|
+
*
|
|
49
|
+
* GET /openmeter/notification/rules
|
|
50
|
+
*/
|
|
51
|
+
export declare function listNotificationRules(client: Client, req?: ListNotificationRulesRequest, options?: RequestOptions): Promise<Result<ListNotificationRulesResponse>>;
|
|
52
|
+
/**
|
|
53
|
+
* Create notification rule
|
|
54
|
+
*
|
|
55
|
+
* Create a notification rule.
|
|
56
|
+
*
|
|
57
|
+
* POST /openmeter/notification/rules
|
|
58
|
+
*/
|
|
59
|
+
export declare function createNotificationRule(client: Client, req: CreateNotificationRuleRequest, options?: RequestOptions): Promise<Result<CreateNotificationRuleResponse>>;
|
|
60
|
+
/**
|
|
61
|
+
* Get notification rule
|
|
62
|
+
*
|
|
63
|
+
* Get a notification rule by id.
|
|
64
|
+
*
|
|
65
|
+
* GET /openmeter/notification/rules/{notificationRuleId}
|
|
66
|
+
*/
|
|
67
|
+
export declare function getNotificationRule(client: Client, req: GetNotificationRuleRequest, options?: RequestOptions): Promise<Result<GetNotificationRuleResponse>>;
|
|
68
|
+
/**
|
|
69
|
+
* Update notification rule
|
|
70
|
+
*
|
|
71
|
+
* Update a notification rule by id.
|
|
72
|
+
*
|
|
73
|
+
* PUT /openmeter/notification/rules/{notificationRuleId}
|
|
74
|
+
*/
|
|
75
|
+
export declare function updateNotificationRule(client: Client, req: UpdateNotificationRuleRequest, options?: RequestOptions): Promise<Result<UpdateNotificationRuleResponse>>;
|
|
76
|
+
/**
|
|
77
|
+
* Delete notification rule
|
|
78
|
+
*
|
|
79
|
+
* Delete a notification rule by id.
|
|
80
|
+
*
|
|
81
|
+
* DELETE /openmeter/notification/rules/{notificationRuleId}
|
|
82
|
+
*/
|
|
83
|
+
export declare function deleteNotificationRule(client: Client, req: DeleteNotificationRuleRequest, options?: RequestOptions): Promise<Result<DeleteNotificationRuleResponse>>;
|
|
84
|
+
/**
|
|
85
|
+
* Test notification rule
|
|
86
|
+
*
|
|
87
|
+
* Test a notification rule by generating an event with sample data and delivering
|
|
88
|
+
* it to the rule's channels. The test event is persisted and listed like any other
|
|
89
|
+
* event.
|
|
90
|
+
*
|
|
91
|
+
* POST /openmeter/notification/rules/{notificationRuleId}/test
|
|
92
|
+
*/
|
|
93
|
+
export declare function testNotificationRule(client: Client, req: TestNotificationRuleRequest, options?: RequestOptions): Promise<Result<TestNotificationRuleResponse>>;
|
|
94
|
+
/**
|
|
95
|
+
* List notification events
|
|
96
|
+
*
|
|
97
|
+
* List all notification events.
|
|
98
|
+
*
|
|
99
|
+
* GET /openmeter/notification/events
|
|
100
|
+
*/
|
|
101
|
+
export declare function listNotificationEvents(client: Client, req?: ListNotificationEventsRequest, options?: RequestOptions): Promise<Result<ListNotificationEventsResponse>>;
|
|
102
|
+
/**
|
|
103
|
+
* Get notification event
|
|
104
|
+
*
|
|
105
|
+
* Get a notification event by id.
|
|
106
|
+
*
|
|
107
|
+
* GET /openmeter/notification/events/{notificationEventId}
|
|
108
|
+
*/
|
|
109
|
+
export declare function getNotificationEvent(client: Client, req: GetNotificationEventRequest, options?: RequestOptions): Promise<Result<GetNotificationEventResponse>>;
|
|
110
|
+
/**
|
|
111
|
+
* Resend notification event
|
|
112
|
+
*
|
|
113
|
+
* Resend a notification event to the channels of the rule that generated it.
|
|
114
|
+
*
|
|
115
|
+
* Delivery is asynchronous: the request marks the selected channels for redelivery
|
|
116
|
+
* and returns immediately. Channels whose delivery is still pending or already
|
|
117
|
+
* being resent are left untouched.
|
|
118
|
+
*
|
|
119
|
+
* POST /openmeter/notification/events/{notificationEventId}/resend
|
|
120
|
+
*/
|
|
121
|
+
export declare function resendNotificationEvent(client: Client, req: ResendNotificationEventRequest, options?: RequestOptions): Promise<Result<ResendNotificationEventResponse>>;
|
|
@@ -161,3 +161,299 @@ export function deleteNotificationChannel(client, req, options) {
|
|
|
161
161
|
await http(client).delete(path, options);
|
|
162
162
|
});
|
|
163
163
|
}
|
|
164
|
+
/**
|
|
165
|
+
* List notification rules
|
|
166
|
+
*
|
|
167
|
+
* List all notification rules.
|
|
168
|
+
*
|
|
169
|
+
* GET /openmeter/notification/rules
|
|
170
|
+
*/
|
|
171
|
+
export function listNotificationRules(client, req = {}, options) {
|
|
172
|
+
return request(() => {
|
|
173
|
+
if (client._options.validate && req.sort !== undefined) {
|
|
174
|
+
assertValid(schemas.listNotificationRulesQueryParams.shape.sort, req.sort);
|
|
175
|
+
}
|
|
176
|
+
const query = toWire({
|
|
177
|
+
page: req.page,
|
|
178
|
+
sort: encodeSort(req.sort, toSnakeCase),
|
|
179
|
+
filter: req.filter,
|
|
180
|
+
}, schemas.listNotificationRulesQueryParams);
|
|
181
|
+
if (client._options.validate) {
|
|
182
|
+
assertValid(schemas.listNotificationRulesQueryParamsWire, query);
|
|
183
|
+
}
|
|
184
|
+
const searchParams = toURLSearchParams(query);
|
|
185
|
+
return http(client)
|
|
186
|
+
.get('openmeter/notification/rules', { ...options, searchParams })
|
|
187
|
+
.json()
|
|
188
|
+
.then((data) => {
|
|
189
|
+
if (client._options.validate) {
|
|
190
|
+
assertValid(schemas.listNotificationRulesResponseWire, data);
|
|
191
|
+
}
|
|
192
|
+
return fromWire(data, schemas.listNotificationRulesResponse);
|
|
193
|
+
});
|
|
194
|
+
});
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* Create notification rule
|
|
198
|
+
*
|
|
199
|
+
* Create a notification rule.
|
|
200
|
+
*
|
|
201
|
+
* POST /openmeter/notification/rules
|
|
202
|
+
*/
|
|
203
|
+
export function createNotificationRule(client, req, options) {
|
|
204
|
+
return request(() => {
|
|
205
|
+
const body = toWire(req, schemas.createNotificationRuleBody);
|
|
206
|
+
if (client._options.validate) {
|
|
207
|
+
assertValid(schemas.createNotificationRuleBodyWire, body);
|
|
208
|
+
}
|
|
209
|
+
return http(client)
|
|
210
|
+
.post('openmeter/notification/rules', { ...options, json: body })
|
|
211
|
+
.json()
|
|
212
|
+
.then((data) => {
|
|
213
|
+
if (client._options.validate) {
|
|
214
|
+
assertValid(schemas.createNotificationRuleResponseWire, data);
|
|
215
|
+
}
|
|
216
|
+
return fromWire(data, schemas.createNotificationRuleResponse);
|
|
217
|
+
});
|
|
218
|
+
});
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* Get notification rule
|
|
222
|
+
*
|
|
223
|
+
* Get a notification rule by id.
|
|
224
|
+
*
|
|
225
|
+
* GET /openmeter/notification/rules/{notificationRuleId}
|
|
226
|
+
*/
|
|
227
|
+
export function getNotificationRule(client, req, options) {
|
|
228
|
+
return request(() => {
|
|
229
|
+
const pathParamsInput = {
|
|
230
|
+
notificationRuleId: req.notificationRuleId,
|
|
231
|
+
};
|
|
232
|
+
const pathParams = client._options.validate
|
|
233
|
+
? toPathWire(pathParamsInput, schemas.getNotificationRulePathParams)
|
|
234
|
+
: pathParamsInput;
|
|
235
|
+
if (client._options.validate) {
|
|
236
|
+
assertValid(schemas.getNotificationRulePathParamsWire, pathParams);
|
|
237
|
+
}
|
|
238
|
+
const path = `openmeter/notification/rules/${(() => {
|
|
239
|
+
if (pathParams.notificationRuleId === undefined) {
|
|
240
|
+
throw new Error('missing path parameter: notificationRuleId');
|
|
241
|
+
}
|
|
242
|
+
return encodeURIComponent(String(pathParams.notificationRuleId));
|
|
243
|
+
})()}`;
|
|
244
|
+
return http(client)
|
|
245
|
+
.get(path, options)
|
|
246
|
+
.json()
|
|
247
|
+
.then((data) => {
|
|
248
|
+
if (client._options.validate) {
|
|
249
|
+
assertValid(schemas.getNotificationRuleResponseWire, data);
|
|
250
|
+
}
|
|
251
|
+
return fromWire(data, schemas.getNotificationRuleResponse);
|
|
252
|
+
});
|
|
253
|
+
});
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* Update notification rule
|
|
257
|
+
*
|
|
258
|
+
* Update a notification rule by id.
|
|
259
|
+
*
|
|
260
|
+
* PUT /openmeter/notification/rules/{notificationRuleId}
|
|
261
|
+
*/
|
|
262
|
+
export function updateNotificationRule(client, req, options) {
|
|
263
|
+
return request(() => {
|
|
264
|
+
const pathParamsInput = {
|
|
265
|
+
notificationRuleId: req.notificationRuleId,
|
|
266
|
+
};
|
|
267
|
+
const pathParams = client._options.validate
|
|
268
|
+
? toPathWire(pathParamsInput, schemas.updateNotificationRulePathParams)
|
|
269
|
+
: pathParamsInput;
|
|
270
|
+
if (client._options.validate) {
|
|
271
|
+
assertValid(schemas.updateNotificationRulePathParamsWire, pathParams);
|
|
272
|
+
}
|
|
273
|
+
const path = `openmeter/notification/rules/${(() => {
|
|
274
|
+
if (pathParams.notificationRuleId === undefined) {
|
|
275
|
+
throw new Error('missing path parameter: notificationRuleId');
|
|
276
|
+
}
|
|
277
|
+
return encodeURIComponent(String(pathParams.notificationRuleId));
|
|
278
|
+
})()}`;
|
|
279
|
+
const body = toWire(req.body, schemas.updateNotificationRuleBody);
|
|
280
|
+
if (client._options.validate) {
|
|
281
|
+
assertValid(schemas.updateNotificationRuleBodyWire, body);
|
|
282
|
+
}
|
|
283
|
+
return http(client)
|
|
284
|
+
.put(path, { ...options, json: body })
|
|
285
|
+
.json()
|
|
286
|
+
.then((data) => {
|
|
287
|
+
if (client._options.validate) {
|
|
288
|
+
assertValid(schemas.updateNotificationRuleResponseWire, data);
|
|
289
|
+
}
|
|
290
|
+
return fromWire(data, schemas.updateNotificationRuleResponse);
|
|
291
|
+
});
|
|
292
|
+
});
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* Delete notification rule
|
|
296
|
+
*
|
|
297
|
+
* Delete a notification rule by id.
|
|
298
|
+
*
|
|
299
|
+
* DELETE /openmeter/notification/rules/{notificationRuleId}
|
|
300
|
+
*/
|
|
301
|
+
export function deleteNotificationRule(client, req, options) {
|
|
302
|
+
return request(async () => {
|
|
303
|
+
const pathParamsInput = {
|
|
304
|
+
notificationRuleId: req.notificationRuleId,
|
|
305
|
+
};
|
|
306
|
+
const pathParams = client._options.validate
|
|
307
|
+
? toPathWire(pathParamsInput, schemas.deleteNotificationRulePathParams)
|
|
308
|
+
: pathParamsInput;
|
|
309
|
+
if (client._options.validate) {
|
|
310
|
+
assertValid(schemas.deleteNotificationRulePathParamsWire, pathParams);
|
|
311
|
+
}
|
|
312
|
+
const path = `openmeter/notification/rules/${(() => {
|
|
313
|
+
if (pathParams.notificationRuleId === undefined) {
|
|
314
|
+
throw new Error('missing path parameter: notificationRuleId');
|
|
315
|
+
}
|
|
316
|
+
return encodeURIComponent(String(pathParams.notificationRuleId));
|
|
317
|
+
})()}`;
|
|
318
|
+
await http(client).delete(path, options);
|
|
319
|
+
});
|
|
320
|
+
}
|
|
321
|
+
/**
|
|
322
|
+
* Test notification rule
|
|
323
|
+
*
|
|
324
|
+
* Test a notification rule by generating an event with sample data and delivering
|
|
325
|
+
* it to the rule's channels. The test event is persisted and listed like any other
|
|
326
|
+
* event.
|
|
327
|
+
*
|
|
328
|
+
* POST /openmeter/notification/rules/{notificationRuleId}/test
|
|
329
|
+
*/
|
|
330
|
+
export function testNotificationRule(client, req, options) {
|
|
331
|
+
return request(() => {
|
|
332
|
+
const pathParamsInput = {
|
|
333
|
+
notificationRuleId: req.notificationRuleId,
|
|
334
|
+
};
|
|
335
|
+
const pathParams = client._options.validate
|
|
336
|
+
? toPathWire(pathParamsInput, schemas.testNotificationRulePathParams)
|
|
337
|
+
: pathParamsInput;
|
|
338
|
+
if (client._options.validate) {
|
|
339
|
+
assertValid(schemas.testNotificationRulePathParamsWire, pathParams);
|
|
340
|
+
}
|
|
341
|
+
const path = `openmeter/notification/rules/${(() => {
|
|
342
|
+
if (pathParams.notificationRuleId === undefined) {
|
|
343
|
+
throw new Error('missing path parameter: notificationRuleId');
|
|
344
|
+
}
|
|
345
|
+
return encodeURIComponent(String(pathParams.notificationRuleId));
|
|
346
|
+
})()}/test`;
|
|
347
|
+
return http(client)
|
|
348
|
+
.post(path, options)
|
|
349
|
+
.json()
|
|
350
|
+
.then((data) => {
|
|
351
|
+
if (client._options.validate) {
|
|
352
|
+
assertValid(schemas.testNotificationRuleResponseWire, data);
|
|
353
|
+
}
|
|
354
|
+
return fromWire(data, schemas.testNotificationRuleResponse);
|
|
355
|
+
});
|
|
356
|
+
});
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
* List notification events
|
|
360
|
+
*
|
|
361
|
+
* List all notification events.
|
|
362
|
+
*
|
|
363
|
+
* GET /openmeter/notification/events
|
|
364
|
+
*/
|
|
365
|
+
export function listNotificationEvents(client, req = {}, options) {
|
|
366
|
+
return request(() => {
|
|
367
|
+
if (client._options.validate && req.sort !== undefined) {
|
|
368
|
+
assertValid(schemas.listNotificationEventsQueryParams.shape.sort, req.sort);
|
|
369
|
+
}
|
|
370
|
+
const query = toWire({
|
|
371
|
+
page: req.page,
|
|
372
|
+
sort: encodeSort(req.sort, toSnakeCase),
|
|
373
|
+
filter: req.filter,
|
|
374
|
+
}, schemas.listNotificationEventsQueryParams);
|
|
375
|
+
if (client._options.validate) {
|
|
376
|
+
assertValid(schemas.listNotificationEventsQueryParamsWire, query);
|
|
377
|
+
}
|
|
378
|
+
const searchParams = toURLSearchParams(query);
|
|
379
|
+
return http(client)
|
|
380
|
+
.get('openmeter/notification/events', { ...options, searchParams })
|
|
381
|
+
.json()
|
|
382
|
+
.then((data) => {
|
|
383
|
+
if (client._options.validate) {
|
|
384
|
+
assertValid(schemas.listNotificationEventsResponseWire, data);
|
|
385
|
+
}
|
|
386
|
+
return fromWire(data, schemas.listNotificationEventsResponse);
|
|
387
|
+
});
|
|
388
|
+
});
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
* Get notification event
|
|
392
|
+
*
|
|
393
|
+
* Get a notification event by id.
|
|
394
|
+
*
|
|
395
|
+
* GET /openmeter/notification/events/{notificationEventId}
|
|
396
|
+
*/
|
|
397
|
+
export function getNotificationEvent(client, req, options) {
|
|
398
|
+
return request(() => {
|
|
399
|
+
const pathParamsInput = {
|
|
400
|
+
notificationEventId: req.notificationEventId,
|
|
401
|
+
};
|
|
402
|
+
const pathParams = client._options.validate
|
|
403
|
+
? toPathWire(pathParamsInput, schemas.getNotificationEventPathParams)
|
|
404
|
+
: pathParamsInput;
|
|
405
|
+
if (client._options.validate) {
|
|
406
|
+
assertValid(schemas.getNotificationEventPathParamsWire, pathParams);
|
|
407
|
+
}
|
|
408
|
+
const path = `openmeter/notification/events/${(() => {
|
|
409
|
+
if (pathParams.notificationEventId === undefined) {
|
|
410
|
+
throw new Error('missing path parameter: notificationEventId');
|
|
411
|
+
}
|
|
412
|
+
return encodeURIComponent(String(pathParams.notificationEventId));
|
|
413
|
+
})()}`;
|
|
414
|
+
return http(client)
|
|
415
|
+
.get(path, options)
|
|
416
|
+
.json()
|
|
417
|
+
.then((data) => {
|
|
418
|
+
if (client._options.validate) {
|
|
419
|
+
assertValid(schemas.getNotificationEventResponseWire, data);
|
|
420
|
+
}
|
|
421
|
+
return fromWire(data, schemas.getNotificationEventResponse);
|
|
422
|
+
});
|
|
423
|
+
});
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* Resend notification event
|
|
427
|
+
*
|
|
428
|
+
* Resend a notification event to the channels of the rule that generated it.
|
|
429
|
+
*
|
|
430
|
+
* Delivery is asynchronous: the request marks the selected channels for redelivery
|
|
431
|
+
* and returns immediately. Channels whose delivery is still pending or already
|
|
432
|
+
* being resent are left untouched.
|
|
433
|
+
*
|
|
434
|
+
* POST /openmeter/notification/events/{notificationEventId}/resend
|
|
435
|
+
*/
|
|
436
|
+
export function resendNotificationEvent(client, req, options) {
|
|
437
|
+
return request(async () => {
|
|
438
|
+
const pathParamsInput = {
|
|
439
|
+
notificationEventId: req.notificationEventId,
|
|
440
|
+
};
|
|
441
|
+
const pathParams = client._options.validate
|
|
442
|
+
? toPathWire(pathParamsInput, schemas.resendNotificationEventPathParams)
|
|
443
|
+
: pathParamsInput;
|
|
444
|
+
if (client._options.validate) {
|
|
445
|
+
assertValid(schemas.resendNotificationEventPathParamsWire, pathParams);
|
|
446
|
+
}
|
|
447
|
+
const path = `openmeter/notification/events/${(() => {
|
|
448
|
+
if (pathParams.notificationEventId === undefined) {
|
|
449
|
+
throw new Error('missing path parameter: notificationEventId');
|
|
450
|
+
}
|
|
451
|
+
return encodeURIComponent(String(pathParams.notificationEventId));
|
|
452
|
+
})()}/resend`;
|
|
453
|
+
const body = toWire(req.body, schemas.resendNotificationEventBody);
|
|
454
|
+
if (client._options.validate) {
|
|
455
|
+
assertValid(schemas.resendNotificationEventBodyWire, body);
|
|
456
|
+
}
|
|
457
|
+
await http(client).post(path, { ...options, json: body });
|
|
458
|
+
});
|
|
459
|
+
}
|
package/dist/index.d.ts
CHANGED
|
@@ -50,4 +50,4 @@ export type * from './models/operations/planAddons.js';
|
|
|
50
50
|
export type * from './models/operations/defaults.js';
|
|
51
51
|
export type * from './models/operations/entitlementAccess.js';
|
|
52
52
|
export type * from './models/operations/notifications.js';
|
|
53
|
-
export type { Labels, CursorPaginationQueryPage, SortQuery, IngestedEventValidationError, CursorMetaPage, BaseError, PageMeta, QueryFilterString, AppStripeCheckoutSessionCustomTextParams, AppStripeCreateCustomerPortalSessionOptions, CreateLabels, CreateVersionFilter, VersionFilter, PriceFree, RateCardStaticEntitlement, RateCardBooleanEntitlement, TaxConfigStripe, TaxConfigExternalInvoicing, InvoiceExternalReferences, InvoiceAvailableActionDetails, InvoiceWorkflowInvoicingSettings, WorkflowPaymentChargeAutomaticallySettings, WorkflowPaymentSendInvoiceSettings, ChargeFlatFeeDiscounts, SubscriptionEditRemoveItem, SubscriptionEditUnscheduleEdit, UpdateLabels, InstallAppStripeWithApiKey, InstallAppSandbox, InstallAppExternalInvoicing, WorkflowCollectionAlignmentSubscription, InvoiceLineExternalReferences, UpdateBillingInvoiceWorkflowInvoicingSettings, UpdateBillingWorkflowPaymentChargeAutomaticallySettings, UpdateBillingWorkflowPaymentSendInvoiceSettings, UpdatePriceFree, LlmCostProvider, LlmCostModel, ProductCatalogValidationError, EntitlementAccessQueryRequestCustomers, EntitlementAccessQueryRequestFeatures, QueryFilterInteger, QueryFilterFloat, QueryFilterBoolean, PagePaginationQuery, PublicLabels, SystemAccountAccessToken, PersonalAccessToken, KonnectAccessToken, AppCustomerDataStripe, AppCustomerDataExternalInvoicing, CreateChargeCostBasisDynamic, ChargeCostBasisDynamic, CurrencyFiat, ListCostBasesParamsFilter, CreateCurrencyCustomRequest, EntitlementAccessValue, EntitlementIssueAfterReset, EntitlementBurndownBalance, EntitlementBurndownGrantBalances, CreateChargeCostBasisManual, ChargeCostBasisManual, PriceFlat, PriceUnit, SpendCommitments, RateCardDiscounts, Totals, ChargeRealizationDetailedLineCreditApplied, ChargeRealizationAmountDiscount, FeatureManualUnitCost, FeatureLlmUnitCostPricing, InvoiceLineCreditsApplied, InvoiceUsageQuantityDetail, UpdatePriceFlat, UpdatePriceUnit, UpdateDiscounts, LlmCostModelPricing, FiatCurrencyAmount, QueryFilterNumeric, CursorPaginationQuery, ListMetersParamsFilter, ListLlmCostPricesParamsFilter, LabelsFieldFilter, CustomerReference, ProfileReference, FeatureReference, EntitlementGrantUsage, CreateChargeCostBasisPinned, CreateResourceReference, ChargeCostBasisPinned, TaxCodeReference, CreditGrantInvoiceReference, CurrencyCustomReference, SubscriptionCostBasisPin, SubscriptionReference, AppReference, ChargeRealizationInvoiceReference, AddonReference, ChargeReference, UpdateResourceReference, BillingCustomerReference, ChargeFeature, Event, MeterQueryRow, AppStripeCreateCustomerPortalSessionResult, ClosedPeriod, ChargeResolvedCostBasis, SubscriptionAddonTimelineSegment, UpdateClosedPeriod, CostBasis, FeatureCostQueryRow, Resource, ResourceImmutable, QueryFilterDateTime, CursorMeta, InvalidParameterStandard, InvalidParameterMinimumLength, InvalidParameterMaximumLength, InvalidParameterChoiceItem, InvalidParameterDependentItem, Unauthorized, Forbidden, NotFound, Gone, Conflict, PayloadTooLarge, UnsupportedMediaType, UnprocessableContent, TooManyRequests, Internal, NotImplemented, NotAvailable, SubscriptionPlanReference, UpsertPlanAddonRequest, ResourceWithKey, Meter, PaginatedMeta, QueryFilterStringMapItem, CustomerKeyReference, CustomerUsageAttribution, UpdateCustomerUsageAttribution, Address, UpdateAddress, AppStripeCreateCheckoutSessionCustomerUpdate, AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement, AppStripeCreateCheckoutSessionTaxIdCollection, AppStripeCreateCheckoutSessionResult, CustomerStripeCreateCustomerPortalSessionRequest, EntitlementAccessCheckResult, RecurringPeriodInput, RecurringPeriod, RateCardMeteredEntitlement, SubscriptionPhaseCreate, SubscriptionEditStretchPhase, GetCreditBalanceParamsFilter, ListPlansParamsFilter, CreateCreditGrantPlanFilter, CreditGrantPlanFilter, ListCreditGrantsParamsFilter, ValidationIssue, SubscriptionProRatingConfig, RateCardProrationConfiguration, UnitConfig, PartyTaxIdentity, UpdateBillingPartyTaxIdentity, InvoiceAvailableActions, ChargeRealizationPayment, SubscriptionEditRemovePhase, TaxCodeAppMapping, AppCapability, UpdateAppStripeRequest, UpdateAppSandboxRequest, UpdateAppExternalInvoicingRequest, WorkflowInvoicingSettings, InvoiceLineAmountDiscount, InvoiceLineUsageDiscount, InvoiceLineBaseDiscount, ListCurrenciesParamsFilter, EntitlementAccessQueryRequest, EntitlementFeatureAccessReason, EntitlementAccessQueryError, NotificationChannel, UpdateBillingNotificationChannelRequest, AppCustomerData, UpsertAppCustomerDataRequest, CreditAdjustment, ListCreditTransactionsParamsFilter, CurrencyAmount, EntitlementValueResult, EntitlementFeatureValueResult, PriceTier, ChargeTotals, FeatureLlmUnitCost, UpdatePriceTier, LlmCostPrice, LlmCostOverrideCreate, ListCustomersParamsFilter, ListCustomerEntitlementsParamsFilter, ListEntitlementsParamsFilter, ListGrantsParamsFilter, ListSubscriptionsParamsFilter, ListAppsParamsFilter, ListBillingProfilesParamsFilter, ListFeatureParamsFilter, ListAddonsParamsFilter, ListPlanAddonsParamsFilter, CreateTaxCodeConfig, TaxCodeConfig, TaxConfig, OrganizationDefaultTaxCodes, CreditBalance, CreditTransaction, InvoiceWorkflowAppsReferences, ProfileAppReferences, PlanAddon, UpdateTaxCodeConfig, ListEventsParamsFilter, ListCustomerChargesParamsFilter, ListInvoicesParamsFilter, ListChargesParamsFilter, ListNotificationChannelsParamsFilter, ResourceFilters, FieldFilters, IngestedEvent, MeterQueryResult, EntitlementHistoryWindow, EntitlementBurndownSegment, ChargeRealizationDetailedLineFlatFee, ChargeRealizationDetailedLineUsageBased, CurrencyCustom, FeatureCostQueryResult, MeterPagePaginatedResponse, CostBasisPagePaginatedResponse, MeterQueryFilters, FeatureMeterReference, Customer, PartyAddresses, InvoiceCustomer, UpdateBillingPartyAddresses, UpdateInvoiceCustomer, AppStripeCreateCheckoutSessionConsentCollection, EntitlementGrantCreateRequest, CreateEntitlementStaticRequest, CreateEntitlementBooleanRequest, EntitlementMetered, EntitlementStatic, EntitlementBoolean, EntitlementGrant, WorkflowCollectionAlignmentAnchored, SubscriptionEditAddPhase, CreateCreditGrantFilters, CreditGrantFilters, SubscriptionBase, InvoiceStatusDetails, InvoiceWorkflow, SubscriptionCancel, SubscriptionMigrate, SubscriptionAddonUpdate, TaxCode, AppCatalogItem, InvoiceLineDiscounts, UpdateBillingInvoiceWorkflow, EntitlementFeatureAccess, NotificationChannelPagePaginatedResponse, CustomerData, UpsertCustomerBillingDataRequest, ChargeFlatFeeSystemIntent, ListCustomerEntitlementAccessResponseData, PriceGraduated, PriceVolume, UpdatePriceGraduated, UpdatePriceVolume, PricePagePaginatedResponse, CreateCreditGrantPurchase, CreditGrantPurchase, CreateChargeFlatFeeRequest, WorkflowTaxSettings, CreditBalances, CreditTransactionPaginatedResponse, PlanAddonPagePaginatedResponse, IngestedEventPaginatedResponse, EntitlementHistory, InvalidParameters, MeterQueryRequest, CustomerPagePaginatedResponse, Supplier, Party, UpdateSupplier, AppStripeCreateCheckoutSessionRequestOptions, CreateEntitlementMeteredRequest, EntitlementGrantPagePaginatedResponse, InvoiceWorkflowSettings, TaxCodePagePaginatedResponse, AppStripe, AppSandbox, AppExternalInvoicing, AppCatalogItemPagePaginatedResponse, InstalledAppStripe, InstalledAppSandbox, InstalledAppExternalInvoicing, InvoiceDetailedLine, UpdateInvoiceWorkflowSettings, EntitlementAccessQueryResult, Feature, CreditGrant, CurrencyPagePaginatedResponse, BadRequest, InvoiceBase, CustomerStripeCreateCheckoutSessionRequest, EntitlementPagePaginatedResponse, WorkflowCollectionSettings, ChargeRealizationInvoice, EntitlementAccessQueryResponse, RateCard, InvoiceLineRateCard, ChargeUsageBasedSystemIntent, CreateChargeUsageBasedRequest, FeaturePagePaginatedResponse, UpdateInvoiceLineRateCard, CreditGrantPagePaginatedResponse, Workflow, AppPagePaginatedResponse, ProfileApps, SubscriptionItem, PlanPhase, SubscriptionEditAddItem, SubscriptionAddonRateCard, Addon, UpsertAddonRequest, InvoiceStandardLine, UpdateInvoiceStandardLine, Profile, UpsertBillingProfileRequest, ChargeRealization, SubscriptionPhase, SubscriptionCustomPlan, Plan, UpsertPlanRequest, SubscriptionAddon, AddonPagePaginatedResponse, ProfilePagePaginatedResponse, Subscription, SubscriptionCreate, SubscriptionChange, PlanPagePaginatedResponse, SubscriptionEdit, SubscriptionAddonPagePaginatedResponse, InvoiceStandard, UpdateInvoiceStandardRequest, SubscriptionPagePaginatedResponse, SubscriptionChangeResponse, SubscriptionMigrateResponse, ChargeFlatFee, ChargeUsageBased, InvoicePagePaginatedResponse, ChargePagePaginatedResponse, StringFieldFilter, MeterAggregation, MeterQueryGranularity, EntitlementHistoryWindowSize, StringFieldFilterExact, PricePaymentTerm, BooleanFieldFilter, BillingCurrencyCode, CreateCurrencyCode, UlidFieldFilter, DateTimeFieldFilter, EntitlementMeasureUsageFrom, WorkflowPaymentSettings, SubscriptionCreateTiming, SubscriptionEditTiming, UpdateBillingWorkflowPaymentSettings, CreateChargeCostBasis, ChargeCostBasis, InvalidParameter, RateCardEntitlement, FeatureUnitCost, ChargeRealizationDetailedLine, Currency, CustomerOrReference, Entitlement, WorkflowCollectionAlignment, Price, PriceUsageBased, UpdatePrice, CreateEntitlementRequest, App, BillingInstallAppResponse, FeatureOrReference, ChargeRealizationInvoiceOrReference, CreateChargeRequest, SubscriptionEditOperation, InvoiceLine, UpdateInvoiceLine, SubscriptionOrReference, Invoice, Charge, SortQueryInput, BaseErrorInput, InvoiceWorkflowInvoicingSettingsInput, WorkflowPaymentSendInvoiceSettingsInput, UpdateBillingInvoiceWorkflowInvoicingSettingsInput, UpdateBillingWorkflowPaymentSendInvoiceSettingsInput, EntitlementIssueAfterResetInput, EventInput, ResetCustomerEntitlementUsageRequestInput, UnauthorizedInput, ForbiddenInput, NotFoundInput, GoneInput, ConflictInput, PayloadTooLargeInput, UnsupportedMediaTypeInput, UnprocessableContentInput, TooManyRequestsInput, InternalInput, NotImplementedInput, NotAvailableInput, AppStripeCreateCheckoutSessionCustomerUpdateInput, AppStripeCreateCheckoutSessionTaxIdCollectionInput, RateCardMeteredEntitlementInput, VoidCreditGrantRequestInput, UnitConfigInput, WorkflowInvoicingSettingsInput, EntitlementAccessQueryRequestInput, NotificationChannelInput, CreateNotificationChannelRequestInput, UpdateBillingNotificationChannelRequestInput, IngestedEventInput, EntitlementMeteredInput, SubscriptionBaseInput, InvoiceWorkflowInput, SubscriptionCancelInput, SubscriptionMigrateInput, UpdateBillingInvoiceWorkflowInput, NotificationChannelPagePaginatedResponseInput, CreateCreditGrantPurchaseInput, CreditGrantPurchaseInput, WorkflowTaxSettingsInput, IngestedEventPaginatedResponseInput, MeterQueryRequestInput, AppStripeCreateCheckoutSessionRequestOptionsInput, CreateEntitlementMeteredRequestInput, InvoiceWorkflowSettingsInput, InvoiceDetailedLineInput, UpdateInvoiceWorkflowSettingsInput, CreateCreditGrantRequestInput, CreditGrantInput, BadRequestInput, CustomerStripeCreateCheckoutSessionRequestInput, EntitlementPagePaginatedResponseInput, WorkflowCollectionSettingsInput, ChargeRealizationInvoiceInput, RateCardInput, InvoiceLineRateCardInput, ChargeUsageBasedSystemIntentInput, CreateChargeUsageBasedRequestInput, CreditGrantPagePaginatedResponseInput, WorkflowInput, SubscriptionItemInput, PlanPhaseInput, SubscriptionEditAddItemInput, SubscriptionAddonRateCardInput, AddonInput, CreateAddonRequestInput, UpsertAddonRequestInput, InvoiceStandardLineInput, ProfileInput, CreateBillingProfileRequestInput, UpsertBillingProfileRequestInput, ChargeRealizationInput, SubscriptionPhaseInput, SubscriptionCustomPlanInput, PlanInput, CreatePlanRequestInput, UpsertPlanRequestInput, SubscriptionAddonInput, AddonPagePaginatedResponseInput, ProfilePagePaginatedResponseInput, SubscriptionInput, SubscriptionCreateInput, SubscriptionChangeInput, PlanPagePaginatedResponseInput, SubscriptionEditInput, SubscriptionAddonPagePaginatedResponseInput, InvoiceStandardInput, UpdateInvoiceStandardRequestInput, SubscriptionPagePaginatedResponseInput, SubscriptionChangeResponseInput, SubscriptionMigrateResponseInput, ChargeFlatFeeInput, ChargeUsageBasedInput, InvoicePagePaginatedResponseInput, ChargePagePaginatedResponseInput, WorkflowPaymentSettingsInput, UpdateBillingWorkflowPaymentSettingsInput, RateCardEntitlementInput, EntitlementInput, CreateEntitlementRequestInput, ChargeRealizationInvoiceOrReferenceInput, CreateChargeRequestInput, SubscriptionEditOperationInput, InvoiceLineInput, SubscriptionOrReferenceInput, InvoiceInput, UpdateInvoiceRequestInput, ChargeInput, } from './models/types.js';
|
|
53
|
+
export type { Labels, CursorPaginationQueryPage, SortQuery, IngestedEventValidationError, CursorMetaPage, BaseError, PageMeta, QueryFilterString, AppStripeCheckoutSessionCustomTextParams, AppStripeCreateCustomerPortalSessionOptions, CreateLabels, CreateVersionFilter, VersionFilter, PriceFree, RateCardStaticEntitlement, RateCardBooleanEntitlement, TaxConfigStripe, TaxConfigExternalInvoicing, InvoiceExternalReferences, InvoiceAvailableActionDetails, InvoiceWorkflowInvoicingSettings, WorkflowPaymentChargeAutomaticallySettings, WorkflowPaymentSendInvoiceSettings, ChargeFlatFeeDiscounts, SubscriptionEditRemoveItem, SubscriptionEditUnscheduleEdit, UpdateLabels, AppReconcileWebhookEventsActionRequest, InstallAppStripeWithApiKey, InstallAppSandbox, InstallAppExternalInvoicing, WorkflowCollectionAlignmentSubscription, InvoiceLineExternalReferences, UpdateBillingInvoiceWorkflowInvoicingSettings, UpdateBillingWorkflowPaymentChargeAutomaticallySettings, UpdateBillingWorkflowPaymentSendInvoiceSettings, UpdatePriceFree, LlmCostProvider, LlmCostModel, ProductCatalogValidationError, EntitlementAccessQueryRequestCustomers, EntitlementAccessQueryRequestFeatures, NotificationEventDeliveryAttemptResponse, QueryFilterInteger, QueryFilterFloat, QueryFilterBoolean, PagePaginationQuery, PublicLabels, SystemAccountAccessToken, PersonalAccessToken, KonnectAccessToken, AppCustomerDataStripe, AppCustomerDataExternalInvoicing, CreateChargeCostBasisDynamic, ChargeCostBasisDynamic, CurrencyFiat, ListCostBasesParamsFilter, CreateCurrencyCustomRequest, EntitlementAccessValue, EntitlementIssueAfterReset, EntitlementBurndownBalance, EntitlementBurndownGrantBalances, CreateChargeCostBasisManual, ChargeCostBasisManual, PriceFlat, PriceUnit, SpendCommitments, RateCardDiscounts, Totals, ChargeRealizationDetailedLineCreditApplied, ChargeRealizationAmountDiscount, FeatureManualUnitCost, FeatureLlmUnitCostPricing, InvoiceLineCreditsApplied, InvoiceUsageQuantityDetail, UpdatePriceFlat, UpdatePriceUnit, UpdateDiscounts, LlmCostModelPricing, FiatCurrencyAmount, QueryFilterNumeric, CursorPaginationQuery, ListMetersParamsFilter, ListLlmCostPricesParamsFilter, LabelsFieldFilter, CustomerReference, ProfileReference, FeatureReference, EntitlementGrantUsage, CreateChargeCostBasisPinned, CreateResourceReference, ChargeCostBasisPinned, TaxCodeReference, CreditGrantInvoiceReference, CurrencyCustomReference, SubscriptionCostBasisPin, SubscriptionReference, AppReference, ChargeRealizationInvoiceReference, AddonReference, ChargeReference, UpdateResourceReference, NotificationChannelReference, NotificationEventFeatureReference, NotificationEventInvoiceReference, ResendBillingNotificationEventRequest, BillingCustomerReference, ChargeFeature, Event, MeterQueryRow, AppStripeCreateCustomerPortalSessionResult, ClosedPeriod, ChargeResolvedCostBasis, SubscriptionAddonTimelineSegment, UpdateClosedPeriod, CostBasis, FeatureCostQueryRow, Resource, ResourceImmutable, QueryFilterDateTime, CursorMeta, InvalidParameterStandard, InvalidParameterMinimumLength, InvalidParameterMaximumLength, InvalidParameterChoiceItem, InvalidParameterDependentItem, Unauthorized, Forbidden, NotFound, Gone, Conflict, PayloadTooLarge, UnsupportedMediaType, UnprocessableContent, TooManyRequests, Internal, NotImplemented, NotAvailable, SubscriptionPlanReference, UpsertPlanAddonRequest, ResourceWithKey, Meter, PaginatedMeta, QueryFilterStringMapItem, CustomerKeyReference, CustomerUsageAttribution, UpdateCustomerUsageAttribution, Address, UpdateAddress, AppStripeCreateCheckoutSessionCustomerUpdate, AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement, AppStripeCreateCheckoutSessionTaxIdCollection, AppStripeCreateCheckoutSessionResult, CustomerStripeCreateCustomerPortalSessionRequest, EntitlementAccessCheckResult, RecurringPeriodInput, RecurringPeriod, RateCardMeteredEntitlement, SubscriptionPhaseCreate, SubscriptionEditStretchPhase, GetCreditBalanceParamsFilter, ListPlansParamsFilter, CreateCreditGrantPlanFilter, CreditGrantPlanFilter, ListCreditGrantsParamsFilter, ValidationIssue, SubscriptionProRatingConfig, RateCardProrationConfiguration, UnitConfig, PartyTaxIdentity, UpdateBillingPartyTaxIdentity, InvoiceAvailableActions, ChargeRealizationPayment, SubscriptionEditRemovePhase, TaxCodeAppMapping, AppCapability, AppAction, UpdateAppStripeRequest, UpdateAppSandboxRequest, UpdateAppExternalInvoicingRequest, WorkflowInvoicingSettings, InvoiceLineAmountDiscount, InvoiceLineUsageDiscount, InvoiceLineBaseDiscount, ListCurrenciesParamsFilter, EntitlementAccessQueryRequest, EntitlementFeatureAccessReason, EntitlementAccessQueryError, NotificationChannel, UpdateBillingNotificationChannelRequest, NotificationBalanceThreshold, NotificationRuleReference, NotificationEventDeliveryAttempt, AppCustomerData, UpsertAppCustomerDataRequest, CreditAdjustment, ListCreditTransactionsParamsFilter, CurrencyAmount, EntitlementValueResult, EntitlementFeatureValueResult, PriceTier, ChargeTotals, FeatureLlmUnitCost, UpdatePriceTier, LlmCostPrice, LlmCostOverrideCreate, ListCustomersParamsFilter, ListCustomerEntitlementsParamsFilter, ListEntitlementsParamsFilter, ListGrantsParamsFilter, ListSubscriptionsParamsFilter, ListAppsParamsFilter, ListBillingProfilesParamsFilter, ListFeatureParamsFilter, ListAddonsParamsFilter, ListPlanAddonsParamsFilter, CreateTaxCodeConfig, TaxCodeConfig, TaxConfig, OrganizationDefaultTaxCodes, CreditBalance, CreditTransaction, InvoiceWorkflowAppsReferences, ProfileAppReferences, PlanAddon, UpdateTaxCodeConfig, NotificationRuleEntitlementReset, NotificationRuleInvoiceCreated, NotificationRuleInvoiceUpdated, NotificationRuleEntitlementResetRequest, NotificationRuleInvoiceCreatedRequest, NotificationRuleInvoiceUpdatedRequest, NotificationEventInvoiceData, ListEventsParamsFilter, ListCustomerChargesParamsFilter, ListInvoicesParamsFilter, ListChargesParamsFilter, ListNotificationChannelsParamsFilter, ListNotificationRulesParamsFilter, ListNotificationEventsParamsFilter, ResourceFilters, FieldFilters, IngestedEvent, MeterQueryResult, EntitlementHistoryWindow, EntitlementBurndownSegment, ChargeRealizationDetailedLineFlatFee, ChargeRealizationDetailedLineUsageBased, CurrencyCustom, FeatureCostQueryResult, MeterPagePaginatedResponse, CostBasisPagePaginatedResponse, MeterQueryFilters, FeatureMeterReference, Customer, PartyAddresses, InvoiceCustomer, UpdateBillingPartyAddresses, UpdateInvoiceCustomer, AppStripeCreateCheckoutSessionConsentCollection, EntitlementGrantCreateRequest, CreateEntitlementStaticRequest, CreateEntitlementBooleanRequest, EntitlementMetered, EntitlementStatic, EntitlementBoolean, EntitlementGrant, WorkflowCollectionAlignmentAnchored, SubscriptionEditAddPhase, CreateCreditGrantFilters, CreditGrantFilters, SubscriptionBase, InvoiceStatusDetails, InvoiceWorkflow, SubscriptionCancel, SubscriptionMigrate, SubscriptionAddonUpdate, TaxCode, AppCatalogItem, InvoiceLineDiscounts, UpdateBillingInvoiceWorkflow, EntitlementFeatureAccess, NotificationChannelPagePaginatedResponse, NotificationRuleBalanceThreshold, NotificationRuleBalanceThresholdRequest, NotificationEventDeliveryStatus, CustomerData, UpsertCustomerBillingDataRequest, ChargeFlatFeeSystemIntent, ListCustomerEntitlementAccessResponseData, NotificationEventBalanceThresholdData, NotificationEventEntitlementData, PriceGraduated, PriceVolume, UpdatePriceGraduated, UpdatePriceVolume, PricePagePaginatedResponse, CreateCreditGrantPurchase, CreditGrantPurchase, CreateChargeFlatFeeRequest, WorkflowTaxSettings, CreditBalances, CreditTransactionPaginatedResponse, PlanAddonPagePaginatedResponse, NotificationEventInvoiceCreatedPayload, NotificationEventInvoiceUpdatedPayload, IngestedEventPaginatedResponse, EntitlementHistory, InvalidParameters, MeterQueryRequest, CustomerPagePaginatedResponse, Supplier, Party, UpdateSupplier, AppStripeCreateCheckoutSessionRequestOptions, CreateEntitlementMeteredRequest, EntitlementGrantPagePaginatedResponse, InvoiceWorkflowSettings, TaxCodePagePaginatedResponse, AppStripe, AppSandbox, AppExternalInvoicing, AppCatalogItemPagePaginatedResponse, InstalledAppStripe, InstalledAppSandbox, InstalledAppExternalInvoicing, InvoiceDetailedLine, UpdateInvoiceWorkflowSettings, EntitlementAccessQueryResult, NotificationEventBalanceThresholdPayload, NotificationEventResetPayload, Feature, CreditGrant, CurrencyPagePaginatedResponse, BadRequest, InvoiceBase, CustomerStripeCreateCheckoutSessionRequest, EntitlementPagePaginatedResponse, WorkflowCollectionSettings, ChargeRealizationInvoice, EntitlementAccessQueryResponse, NotificationRulePagePaginatedResponse, RateCard, InvoiceLineRateCard, ChargeUsageBasedSystemIntent, CreateChargeUsageBasedRequest, FeaturePagePaginatedResponse, UpdateInvoiceLineRateCard, CreditGrantPagePaginatedResponse, Workflow, AppPagePaginatedResponse, ProfileApps, NotificationEvent, SubscriptionItem, PlanPhase, SubscriptionEditAddItem, SubscriptionAddonRateCard, Addon, UpsertAddonRequest, InvoiceStandardLine, UpdateInvoiceStandardLine, Profile, UpsertBillingProfileRequest, ChargeRealization, NotificationEventPagePaginatedResponse, SubscriptionPhase, SubscriptionCustomPlan, Plan, UpsertPlanRequest, SubscriptionAddon, AddonPagePaginatedResponse, ProfilePagePaginatedResponse, Subscription, SubscriptionCreate, SubscriptionChange, PlanPagePaginatedResponse, SubscriptionEdit, SubscriptionAddonPagePaginatedResponse, InvoiceStandard, UpdateInvoiceStandardRequest, SubscriptionPagePaginatedResponse, SubscriptionChangeResponse, SubscriptionMigrateResponse, ChargeFlatFee, ChargeUsageBased, InvoicePagePaginatedResponse, ChargePagePaginatedResponse, StringFieldFilter, MeterAggregation, MeterQueryGranularity, EntitlementHistoryWindowSize, StringFieldFilterExact, PricePaymentTerm, BooleanFieldFilter, BillingCurrencyCode, CreateCurrencyCode, UlidFieldFilter, DateTimeFieldFilter, EntitlementMeasureUsageFrom, WorkflowPaymentSettings, SubscriptionCreateTiming, SubscriptionEditTiming, AppActionRequest, UpdateBillingWorkflowPaymentSettings, CreateChargeCostBasis, ChargeCostBasis, InvalidParameter, RateCardEntitlement, FeatureUnitCost, ChargeRealizationDetailedLine, Currency, CustomerOrReference, Entitlement, WorkflowCollectionAlignment, NotificationRule, NotificationRuleRequest, Price, PriceUsageBased, UpdatePrice, CreateEntitlementRequest, App, BillingInstallAppResponse, NotificationEventPayload, FeatureOrReference, ChargeRealizationInvoiceOrReference, CreateChargeRequest, SubscriptionEditOperation, InvoiceLine, UpdateInvoiceLine, SubscriptionOrReference, Invoice, Charge, SortQueryInput, BaseErrorInput, InvoiceWorkflowInvoicingSettingsInput, WorkflowPaymentSendInvoiceSettingsInput, UpdateBillingInvoiceWorkflowInvoicingSettingsInput, UpdateBillingWorkflowPaymentSendInvoiceSettingsInput, EntitlementIssueAfterResetInput, EventInput, ResetCustomerEntitlementUsageRequestInput, UnauthorizedInput, ForbiddenInput, NotFoundInput, GoneInput, ConflictInput, PayloadTooLargeInput, UnsupportedMediaTypeInput, UnprocessableContentInput, TooManyRequestsInput, InternalInput, NotImplementedInput, NotAvailableInput, AppStripeCreateCheckoutSessionCustomerUpdateInput, AppStripeCreateCheckoutSessionTaxIdCollectionInput, RateCardMeteredEntitlementInput, VoidCreditGrantRequestInput, UnitConfigInput, WorkflowInvoicingSettingsInput, EntitlementAccessQueryRequestInput, NotificationChannelInput, CreateNotificationChannelRequestInput, UpdateBillingNotificationChannelRequestInput, NotificationRuleEntitlementResetInput, NotificationRuleInvoiceCreatedInput, NotificationRuleInvoiceUpdatedInput, NotificationRuleEntitlementResetRequestInput, NotificationRuleInvoiceCreatedRequestInput, NotificationRuleInvoiceUpdatedRequestInput, IngestedEventInput, EntitlementMeteredInput, SubscriptionBaseInput, InvoiceWorkflowInput, SubscriptionCancelInput, SubscriptionMigrateInput, UpdateBillingInvoiceWorkflowInput, NotificationChannelPagePaginatedResponseInput, NotificationRuleBalanceThresholdInput, NotificationRuleBalanceThresholdRequestInput, CreateCreditGrantPurchaseInput, CreditGrantPurchaseInput, WorkflowTaxSettingsInput, IngestedEventPaginatedResponseInput, MeterQueryRequestInput, AppStripeCreateCheckoutSessionRequestOptionsInput, CreateEntitlementMeteredRequestInput, InvoiceWorkflowSettingsInput, InvoiceDetailedLineInput, UpdateInvoiceWorkflowSettingsInput, CreateCreditGrantRequestInput, CreditGrantInput, BadRequestInput, CustomerStripeCreateCheckoutSessionRequestInput, EntitlementPagePaginatedResponseInput, WorkflowCollectionSettingsInput, ChargeRealizationInvoiceInput, NotificationRulePagePaginatedResponseInput, RateCardInput, InvoiceLineRateCardInput, ChargeUsageBasedSystemIntentInput, CreateChargeUsageBasedRequestInput, CreditGrantPagePaginatedResponseInput, WorkflowInput, SubscriptionItemInput, PlanPhaseInput, SubscriptionEditAddItemInput, SubscriptionAddonRateCardInput, AddonInput, CreateAddonRequestInput, UpsertAddonRequestInput, InvoiceStandardLineInput, ProfileInput, CreateBillingProfileRequestInput, UpsertBillingProfileRequestInput, ChargeRealizationInput, SubscriptionPhaseInput, SubscriptionCustomPlanInput, PlanInput, CreatePlanRequestInput, UpsertPlanRequestInput, SubscriptionAddonInput, AddonPagePaginatedResponseInput, ProfilePagePaginatedResponseInput, SubscriptionInput, SubscriptionCreateInput, SubscriptionChangeInput, PlanPagePaginatedResponseInput, SubscriptionEditInput, SubscriptionAddonPagePaginatedResponseInput, InvoiceStandardInput, UpdateInvoiceStandardRequestInput, SubscriptionPagePaginatedResponseInput, SubscriptionChangeResponseInput, SubscriptionMigrateResponseInput, ChargeFlatFeeInput, ChargeUsageBasedInput, InvoicePagePaginatedResponseInput, ChargePagePaginatedResponseInput, WorkflowPaymentSettingsInput, UpdateBillingWorkflowPaymentSettingsInput, RateCardEntitlementInput, EntitlementInput, NotificationRuleInput, NotificationRuleRequestInput, CreateEntitlementRequestInput, ChargeRealizationInvoiceOrReferenceInput, CreateChargeRequestInput, SubscriptionEditOperationInput, InvoiceLineInput, SubscriptionOrReferenceInput, InvoiceInput, UpdateInvoiceRequestInput, ChargeInput, } from './models/types.js';
|
package/dist/lib/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "v1.0.0-beta.
|
|
1
|
+
export declare const SDK_VERSION = "v1.0.0-beta.236";
|
package/dist/lib/version.js
CHANGED
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
// The committed value is a dev placeholder. The publish flow
|
|
3
3
|
// (`make -C api/spec publish-aip-sdk`) stamps the real release version here
|
|
4
4
|
// before `pnpm publish`, after `pnpm version` updates package.json.
|
|
5
|
-
export const SDK_VERSION = 'v1.0.0-beta.
|
|
5
|
+
export const SDK_VERSION = 'v1.0.0-beta.236';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { AcceptDateStrings } from '../../lib/wire.js';
|
|
2
|
-
import type { App, AppCatalogItem, AppCatalogItemPagePaginatedResponse, AppPagePaginatedResponse, BillingInstallAppResponse, InstallAppRequest as InstallAppRequestBody, ListAppsParamsFilter, SortQueryInput, UpdateAppRequest as UpdateAppRequestBody } from '../types.js';
|
|
2
|
+
import type { App, AppActionRequest, AppCatalogItem, AppCatalogItemPagePaginatedResponse, AppPagePaginatedResponse, BillingInstallAppResponse, InstallAppRequest as InstallAppRequestBody, ListAppsParamsFilter, SortQueryInput, UpdateAppRequest as UpdateAppRequestBody } from '../types.js';
|
|
3
3
|
export interface ListAppsQuery {
|
|
4
4
|
/** Determines which page of the collection to retrieve. */
|
|
5
5
|
page?: {
|
|
@@ -38,6 +38,11 @@ export type UpdateAppRequest = AcceptDateStrings<{
|
|
|
38
38
|
body: UpdateAppRequestBody;
|
|
39
39
|
}>;
|
|
40
40
|
export type UpdateAppResponse = App;
|
|
41
|
+
export type ExecuteAppActionRequest = AcceptDateStrings<{
|
|
42
|
+
appId: string;
|
|
43
|
+
body: AppActionRequest;
|
|
44
|
+
}>;
|
|
45
|
+
export type ExecuteAppActionResponse = App;
|
|
41
46
|
export interface ListAppCatalogQuery {
|
|
42
47
|
/** Determines which page of the collection to retrieve. */
|
|
43
48
|
page?: {
|