@openmeter/client 1.0.0-beta.233 → 1.0.0-beta.234
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 +52 -14
- package/dist/funcs/customers.d.ts +112 -1
- package/dist/funcs/customers.js +430 -0
- package/dist/funcs/entitlements.d.ts +38 -1
- package/dist/funcs/entitlements.js +169 -6
- package/dist/funcs/grants.d.ts +24 -0
- package/dist/funcs/grants.js +78 -0
- package/dist/funcs/index.d.ts +2 -0
- package/dist/funcs/index.js +2 -0
- package/dist/funcs/notifications.d.ts +43 -0
- package/dist/funcs/notifications.js +163 -0
- package/dist/index.d.ts +3 -1
- package/dist/lib/version.d.ts +1 -1
- package/dist/lib/version.js +1 -1
- package/dist/models/operations/customers.d.ts +109 -1
- package/dist/models/operations/entitlements.d.ts +59 -4
- package/dist/models/operations/grants.d.ts +43 -0
- package/dist/models/operations/grants.js +2 -0
- package/dist/models/operations/notifications.d.ts +46 -0
- package/dist/models/operations/notifications.js +2 -0
- package/dist/models/schemas.d.ts +6549 -2716
- package/dist/models/schemas.js +1795 -360
- package/dist/models/types.d.ts +1175 -228
- package/dist/sdk/apps.d.ts +20 -1
- package/dist/sdk/apps.js +24 -1
- package/dist/sdk/entitlements.d.ts +1 -9
- package/dist/sdk/entitlements.js +1 -11
- package/dist/sdk/internal.d.ts +324 -22
- package/dist/sdk/internal.js +397 -25
- package/dist/sdk/notifications.d.ts +58 -0
- package/dist/sdk/notifications.js +72 -0
- package/dist/sdk/subscriptions.d.ts +1 -9
- package/dist/sdk/subscriptions.js +1 -11
- package/package.json +1 -1
package/dist/sdk/apps.d.ts
CHANGED
|
@@ -1,9 +1,28 @@
|
|
|
1
1
|
import { type Client } from '../core.js';
|
|
2
2
|
import { type RequestOptions } from '../lib/types.js';
|
|
3
|
-
import type { GetAppRequest, GetAppResponse } from '../models/operations/apps.js';
|
|
3
|
+
import type { ListAppsRequest, ListAppsResponse, GetAppRequest, GetAppResponse } from '../models/operations/apps.js';
|
|
4
|
+
import type { App } from '../models/types.js';
|
|
4
5
|
export declare class Apps {
|
|
5
6
|
private readonly _client;
|
|
6
7
|
constructor(_client: Client);
|
|
8
|
+
/**
|
|
9
|
+
* List apps
|
|
10
|
+
*
|
|
11
|
+
* List installed apps.
|
|
12
|
+
*
|
|
13
|
+
* GET /openmeter/apps
|
|
14
|
+
*/
|
|
15
|
+
list(request?: ListAppsRequest, options?: RequestOptions): Promise<ListAppsResponse>;
|
|
16
|
+
/**
|
|
17
|
+
* List apps
|
|
18
|
+
*
|
|
19
|
+
* List installed apps.
|
|
20
|
+
*
|
|
21
|
+
* Iterates every item across all pages, fetching more as the returned iterable is consumed.
|
|
22
|
+
*
|
|
23
|
+
* GET /openmeter/apps
|
|
24
|
+
*/
|
|
25
|
+
listAll(request?: ListAppsRequest, options?: RequestOptions): AsyncIterable<App>;
|
|
7
26
|
/**
|
|
8
27
|
* Get app
|
|
9
28
|
*
|
package/dist/sdk/apps.js
CHANGED
|
@@ -1,11 +1,34 @@
|
|
|
1
1
|
// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
|
|
2
2
|
import { unwrap } from '../lib/types.js';
|
|
3
|
-
import {
|
|
3
|
+
import { paginatePages } from '../lib/paginate.js';
|
|
4
|
+
import { listApps, getApp } from '../funcs/apps.js';
|
|
4
5
|
export class Apps {
|
|
5
6
|
_client;
|
|
6
7
|
constructor(_client) {
|
|
7
8
|
this._client = _client;
|
|
8
9
|
}
|
|
10
|
+
/**
|
|
11
|
+
* List apps
|
|
12
|
+
*
|
|
13
|
+
* List installed apps.
|
|
14
|
+
*
|
|
15
|
+
* GET /openmeter/apps
|
|
16
|
+
*/
|
|
17
|
+
async list(request, options) {
|
|
18
|
+
return unwrap(await listApps(this._client, request, options));
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* List apps
|
|
22
|
+
*
|
|
23
|
+
* List installed apps.
|
|
24
|
+
*
|
|
25
|
+
* Iterates every item across all pages, fetching more as the returned iterable is consumed.
|
|
26
|
+
*
|
|
27
|
+
* GET /openmeter/apps
|
|
28
|
+
*/
|
|
29
|
+
listAll(request, options) {
|
|
30
|
+
return paginatePages((req, opts) => listApps(this._client, req, opts), request ?? {}, options);
|
|
31
|
+
}
|
|
9
32
|
/**
|
|
10
33
|
* Get app
|
|
11
34
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type Client } from '../core.js';
|
|
2
2
|
import { type RequestOptions } from '../lib/types.js';
|
|
3
|
-
import type { ListCustomerEntitlementAccessRequest, ListCustomerEntitlementAccessResponse
|
|
3
|
+
import type { ListCustomerEntitlementAccessRequest, ListCustomerEntitlementAccessResponse } from '../models/operations/entitlements.js';
|
|
4
4
|
export declare class Entitlements {
|
|
5
5
|
private readonly _client;
|
|
6
6
|
constructor(_client: Client);
|
|
@@ -10,12 +10,4 @@ export declare class Entitlements {
|
|
|
10
10
|
* GET /openmeter/customers/{customerId}/entitlement-access
|
|
11
11
|
*/
|
|
12
12
|
listCustomerAccess(request: ListCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<ListCustomerEntitlementAccessResponse>;
|
|
13
|
-
/**
|
|
14
|
-
* Get customer entitlement access
|
|
15
|
-
*
|
|
16
|
-
* Get the customer's access to a single feature.
|
|
17
|
-
*
|
|
18
|
-
* GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
|
|
19
|
-
*/
|
|
20
|
-
getCustomerAccess(request: GetCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<GetCustomerEntitlementAccessResponse>;
|
|
21
13
|
}
|
package/dist/sdk/entitlements.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
|
|
2
2
|
import { unwrap } from '../lib/types.js';
|
|
3
|
-
import { listCustomerEntitlementAccess
|
|
3
|
+
import { listCustomerEntitlementAccess } from '../funcs/entitlements.js';
|
|
4
4
|
export class Entitlements {
|
|
5
5
|
_client;
|
|
6
6
|
constructor(_client) {
|
|
@@ -14,14 +14,4 @@ export class Entitlements {
|
|
|
14
14
|
async listCustomerAccess(request, options) {
|
|
15
15
|
return unwrap(await listCustomerEntitlementAccess(this._client, request, options));
|
|
16
16
|
}
|
|
17
|
-
/**
|
|
18
|
-
* Get customer entitlement access
|
|
19
|
-
*
|
|
20
|
-
* Get the customer's access to a single feature.
|
|
21
|
-
*
|
|
22
|
-
* GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
|
|
23
|
-
*/
|
|
24
|
-
async getCustomerAccess(request, options) {
|
|
25
|
-
return unwrap(await getCustomerEntitlementAccess(this._client, request, options));
|
|
26
|
-
}
|
|
27
17
|
}
|
package/dist/sdk/internal.d.ts
CHANGED
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
import { type Client } from '../core.js';
|
|
2
2
|
import { type RequestOptions } from '../lib/types.js';
|
|
3
|
-
import type { VoidCreditGrantRequest, VoidCreditGrantResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
|
|
4
|
-
import type {
|
|
5
|
-
import type {
|
|
3
|
+
import type { CreateCustomerEntitlementRequest, CreateCustomerEntitlementResponse, OverrideCustomerEntitlementRequest, OverrideCustomerEntitlementResponse, GetCustomerEntitlementHistoryRequest, GetCustomerEntitlementHistoryResponse, GetCustomerEntitlementRequest, GetCustomerEntitlementResponse, ListCustomerEntitlementsRequest, ListCustomerEntitlementsResponse, ResetCustomerEntitlementUsageRequest, ResetCustomerEntitlementUsageResponse, DeleteCustomerEntitlementRequest, DeleteCustomerEntitlementResponse, CreateCustomerEntitlementGrantRequest, CreateCustomerEntitlementGrantResponse, ListCustomerEntitlementGrantsRequest, ListCustomerEntitlementGrantsResponse, VoidCreditGrantRequest, VoidCreditGrantResponse, ListCustomerChargesRequest, ListCustomerChargesResponse, CreateCustomerChargesRequest, CreateCustomerChargesResponse } from '../models/operations/customers.js';
|
|
4
|
+
import type { GetCustomerEntitlementAccessRequest, GetCustomerEntitlementAccessResponse, GetCustomerEntitlementValueByFeatureKeyRequest, GetCustomerEntitlementValueByFeatureKeyResponse, ListEntitlementsRequest, ListEntitlementsResponse, GetEntitlementRequest, GetEntitlementResponse, GetCustomerEntitlementValueRequest, GetCustomerEntitlementValueResponse } from '../models/operations/entitlements.js';
|
|
5
|
+
import type { ListGrantsRequest, ListGrantsResponse, VoidGrantRequest, VoidGrantResponse } from '../models/operations/grants.js';
|
|
6
|
+
import type { UnscheduleSubscriptionRequest, UnscheduleSubscriptionResponse, RestoreSubscriptionRequest, RestoreSubscriptionResponse, MigrateSubscriptionRequest, MigrateSubscriptionResponse, CreateSubscriptionAddonRequest, CreateSubscriptionAddonResponse, UpdateSubscriptionAddonRequest, UpdateSubscriptionAddonResponse } from '../models/operations/subscriptions.js';
|
|
7
|
+
import type { UninstallAppRequest, UninstallAppResponse, UpdateAppRequest, UpdateAppResponse, ListAppCatalogRequest, ListAppCatalogResponse, GetAppCatalogItemRequest, GetAppCatalogItemResponse, InstallAppRequest, InstallAppResponse } from '../models/operations/apps.js';
|
|
6
8
|
import type { ListInvoicesRequest, ListInvoicesResponse, GetInvoiceRequest, GetInvoiceResponse, UpdateInvoiceRequest, UpdateInvoiceResponse, DeleteInvoiceRequest, DeleteInvoiceResponse, AdvanceInvoiceRequest, AdvanceInvoiceResponse, ApproveInvoiceRequest, ApproveInvoiceResponse, RetryInvoiceRequest, RetryInvoiceResponse, SnapshotQuantitiesInvoiceRequest, SnapshotQuantitiesInvoiceResponse } from '../models/operations/invoices.js';
|
|
7
9
|
import type { ListChargesRequest, ListChargesResponse } from '../models/operations/charges.js';
|
|
8
10
|
import type { ListCurrenciesRequest, ListCurrenciesResponse, CreateCustomCurrencyRequest, CreateCustomCurrencyResponse, GetCustomCurrencyRequest, GetCustomCurrencyResponse, ListCostBasesRequest, ListCostBasesResponse, CreateCostBasisRequest, CreateCostBasisResponse } from '../models/operations/currencies.js';
|
|
9
11
|
import type { ListPlanAddonsRequest, ListPlanAddonsResponse } from '../models/operations/planAddons.js';
|
|
10
12
|
import type { QueryEntitlementAccessRequest, QueryEntitlementAccessResponse } from '../models/operations/entitlementAccess.js';
|
|
11
|
-
import type {
|
|
13
|
+
import type { ListNotificationChannelsRequest, ListNotificationChannelsResponse, CreateNotificationChannelRequest, CreateNotificationChannelResponse, GetNotificationChannelRequest, GetNotificationChannelResponse, UpdateNotificationChannelRequest, UpdateNotificationChannelResponse, DeleteNotificationChannelRequest, DeleteNotificationChannelResponse } from '../models/operations/notifications.js';
|
|
14
|
+
import type { AppCatalogItem, Charge, CostBasis, Currency, Entitlement, EntitlementGrant, Invoice, NotificationChannel, PlanAddon } from '../models/types.js';
|
|
12
15
|
/**
|
|
13
16
|
* Operations marked internal in the API definition. They are not part of
|
|
14
17
|
* the customer surface: they may require additional permissions, and they
|
|
@@ -19,6 +22,10 @@ export declare class Internal {
|
|
|
19
22
|
constructor(_client: Client);
|
|
20
23
|
private _customers?;
|
|
21
24
|
get customers(): InternalCustomers;
|
|
25
|
+
private _entitlements?;
|
|
26
|
+
get entitlements(): InternalEntitlements;
|
|
27
|
+
private _grants?;
|
|
28
|
+
get grants(): InternalGrants;
|
|
22
29
|
private _subscriptions?;
|
|
23
30
|
get subscriptions(): InternalSubscriptions;
|
|
24
31
|
private _apps?;
|
|
@@ -33,15 +40,166 @@ export declare class Internal {
|
|
|
33
40
|
get planAddons(): InternalPlanAddons;
|
|
34
41
|
private _entitlementAccess?;
|
|
35
42
|
get entitlementAccess(): InternalEntitlementAccess;
|
|
43
|
+
private _notifications?;
|
|
44
|
+
get notifications(): InternalNotifications;
|
|
36
45
|
}
|
|
37
46
|
export declare class InternalCustomers {
|
|
38
47
|
private readonly _client;
|
|
39
48
|
constructor(_client: Client);
|
|
49
|
+
private _entitlements?;
|
|
50
|
+
get entitlements(): InternalCustomersEntitlements;
|
|
40
51
|
private _credits?;
|
|
41
52
|
get credits(): InternalCustomersCredits;
|
|
42
53
|
private _charges?;
|
|
43
54
|
get charges(): InternalCustomersCharges;
|
|
44
55
|
}
|
|
56
|
+
export declare class InternalCustomersEntitlements {
|
|
57
|
+
private readonly _client;
|
|
58
|
+
constructor(_client: Client);
|
|
59
|
+
/**
|
|
60
|
+
* Create customer entitlement
|
|
61
|
+
*
|
|
62
|
+
* Create an entitlement for the customer.
|
|
63
|
+
*
|
|
64
|
+
* A customer can have only one active entitlement per feature. The feature must be
|
|
65
|
+
* compatible with the entitlement type. Entitlements cannot be modified after
|
|
66
|
+
* creation, only deleted.
|
|
67
|
+
*
|
|
68
|
+
* POST /openmeter/customers/{customerId}/entitlements
|
|
69
|
+
*/
|
|
70
|
+
create(request: CreateCustomerEntitlementRequest, options?: RequestOptions): Promise<CreateCustomerEntitlementResponse>;
|
|
71
|
+
/**
|
|
72
|
+
* Override customer entitlement
|
|
73
|
+
*
|
|
74
|
+
* Override an entitlement of the customer with a new one.
|
|
75
|
+
*
|
|
76
|
+
* The referenced entitlement ends and the new one starts at the same instant, so
|
|
77
|
+
* access continues without a gap. Both must belong to the same feature. Use this
|
|
78
|
+
* for upgrades and downgrades.
|
|
79
|
+
*
|
|
80
|
+
* Fails if the referenced entitlement does not exist, is deleted, or is no longer
|
|
81
|
+
* active.
|
|
82
|
+
*
|
|
83
|
+
* PUT /openmeter/customers/{customerId}/entitlements/{entitlementId}/override
|
|
84
|
+
*/
|
|
85
|
+
override(request: OverrideCustomerEntitlementRequest, options?: RequestOptions): Promise<OverrideCustomerEntitlementResponse>;
|
|
86
|
+
/**
|
|
87
|
+
* Get customer entitlement history
|
|
88
|
+
*
|
|
89
|
+
* Get the balance and usage history of a metered entitlement. The queried range
|
|
90
|
+
* may span multiple usage periods.
|
|
91
|
+
*
|
|
92
|
+
* `windowed_history` groups usage into windows of the requested size and reports
|
|
93
|
+
* the balance at the start of each window. `burndown_history` lists the periods in
|
|
94
|
+
* which grants were consumed in a fixed order, together with the usage taken from
|
|
95
|
+
* each grant.
|
|
96
|
+
*
|
|
97
|
+
* GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/history
|
|
98
|
+
*/
|
|
99
|
+
getHistory(request: GetCustomerEntitlementHistoryRequest, options?: RequestOptions): Promise<GetCustomerEntitlementHistoryResponse>;
|
|
100
|
+
/**
|
|
101
|
+
* Get customer entitlement
|
|
102
|
+
*
|
|
103
|
+
* Get an entitlement of the customer by ID. For checking entitlement access, use
|
|
104
|
+
* the entitlement access endpoints instead.
|
|
105
|
+
*
|
|
106
|
+
* GET /openmeter/customers/{customerId}/entitlements/{entitlementId}
|
|
107
|
+
*/
|
|
108
|
+
get(request: GetCustomerEntitlementRequest, options?: RequestOptions): Promise<GetCustomerEntitlementResponse>;
|
|
109
|
+
/**
|
|
110
|
+
* List customer entitlements
|
|
111
|
+
*
|
|
112
|
+
* List the entitlements of the customer that are active at the time of the
|
|
113
|
+
* request. For checking entitlement access, use the entitlement access endpoints
|
|
114
|
+
* instead.
|
|
115
|
+
*
|
|
116
|
+
* GET /openmeter/customers/{customerId}/entitlements
|
|
117
|
+
*/
|
|
118
|
+
list(request: ListCustomerEntitlementsRequest, options?: RequestOptions): Promise<ListCustomerEntitlementsResponse>;
|
|
119
|
+
/**
|
|
120
|
+
* List customer entitlements
|
|
121
|
+
*
|
|
122
|
+
* List the entitlements of the customer that are active at the time of the
|
|
123
|
+
* request. For checking entitlement access, use the entitlement access endpoints
|
|
124
|
+
* instead.
|
|
125
|
+
*
|
|
126
|
+
* Iterates every item across all pages, fetching more as the returned iterable is consumed.
|
|
127
|
+
*
|
|
128
|
+
* GET /openmeter/customers/{customerId}/entitlements
|
|
129
|
+
*/
|
|
130
|
+
listAll(request: ListCustomerEntitlementsRequest, options?: RequestOptions): AsyncIterable<Entitlement>;
|
|
131
|
+
/**
|
|
132
|
+
* Reset customer entitlement usage
|
|
133
|
+
*
|
|
134
|
+
* Reset the usage of a metered entitlement. The reset starts a new usage period:
|
|
135
|
+
* usage is zeroed and grants roll over according to their rollover settings.
|
|
136
|
+
*
|
|
137
|
+
* Usage is reset automatically at the end of each usage period. Use this operation
|
|
138
|
+
* to reset it earlier, for example to align the entitlement with the customer's
|
|
139
|
+
* billing period. The usage period anchor can be moved at the same time.
|
|
140
|
+
*
|
|
141
|
+
* POST /openmeter/customers/{customerId}/entitlements/{entitlementId}/reset
|
|
142
|
+
*/
|
|
143
|
+
resetUsage(request: ResetCustomerEntitlementUsageRequest, options?: RequestOptions): Promise<ResetCustomerEntitlementUsageResponse>;
|
|
144
|
+
/**
|
|
145
|
+
* Delete customer entitlement
|
|
146
|
+
*
|
|
147
|
+
* Deletes the entitlement and revokes access to its feature. A customer can hold
|
|
148
|
+
* only one active entitlement per feature, so migrating a feature requires
|
|
149
|
+
* deleting the previous entitlement first.
|
|
150
|
+
*
|
|
151
|
+
* Deletion sets the `deleted_at` timestamp instead of removing history. Access and
|
|
152
|
+
* status queries for earlier points in time still treat the entitlement as active,
|
|
153
|
+
* so access changes are never retroactive.
|
|
154
|
+
*
|
|
155
|
+
* DELETE /openmeter/customers/{customerId}/entitlements/{entitlementId}
|
|
156
|
+
*/
|
|
157
|
+
delete(request: DeleteCustomerEntitlementRequest, options?: RequestOptions): Promise<DeleteCustomerEntitlementResponse>;
|
|
158
|
+
private _grants?;
|
|
159
|
+
get grants(): InternalCustomersEntitlementsGrants;
|
|
160
|
+
}
|
|
161
|
+
export declare class InternalCustomersEntitlementsGrants {
|
|
162
|
+
private readonly _client;
|
|
163
|
+
constructor(_client: Client);
|
|
164
|
+
/**
|
|
165
|
+
* Create customer entitlement grant
|
|
166
|
+
*
|
|
167
|
+
* Issue a grant for a metered entitlement of the customer. Boolean and static
|
|
168
|
+
* entitlements cannot have grants, so the request is rejected for them.
|
|
169
|
+
*
|
|
170
|
+
* Grants are immutable. The amount is added to the balance from `effective_at`,
|
|
171
|
+
* which cannot be earlier than the start of the current usage period.
|
|
172
|
+
*
|
|
173
|
+
* POST /openmeter/customers/{customerId}/entitlements/{entitlementId}/grants
|
|
174
|
+
*/
|
|
175
|
+
create(request: CreateCustomerEntitlementGrantRequest, options?: RequestOptions): Promise<CreateCustomerEntitlementGrantResponse>;
|
|
176
|
+
/**
|
|
177
|
+
* List customer entitlement grants
|
|
178
|
+
*
|
|
179
|
+
* List the grants issued for an entitlement of the customer. Grants only exist for
|
|
180
|
+
* metered entitlements, so the list is empty for boolean and static entitlements.
|
|
181
|
+
*
|
|
182
|
+
* Deleted grants are excluded unless `include_deleted` is set. Voided and expired
|
|
183
|
+
* grants are always included, as they are part of the balance history.
|
|
184
|
+
*
|
|
185
|
+
* GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/grants
|
|
186
|
+
*/
|
|
187
|
+
list(request: ListCustomerEntitlementGrantsRequest, options?: RequestOptions): Promise<ListCustomerEntitlementGrantsResponse>;
|
|
188
|
+
/**
|
|
189
|
+
* List customer entitlement grants
|
|
190
|
+
*
|
|
191
|
+
* List the grants issued for an entitlement of the customer. Grants only exist for
|
|
192
|
+
* metered entitlements, so the list is empty for boolean and static entitlements.
|
|
193
|
+
*
|
|
194
|
+
* Deleted grants are excluded unless `include_deleted` is set. Voided and expired
|
|
195
|
+
* grants are always included, as they are part of the balance history.
|
|
196
|
+
*
|
|
197
|
+
* Iterates every item across all pages, fetching more as the returned iterable is consumed.
|
|
198
|
+
*
|
|
199
|
+
* GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/grants
|
|
200
|
+
*/
|
|
201
|
+
listAll(request: ListCustomerEntitlementGrantsRequest, options?: RequestOptions): AsyncIterable<EntitlementGrant>;
|
|
202
|
+
}
|
|
45
203
|
export declare class InternalCustomersCredits {
|
|
46
204
|
private readonly _client;
|
|
47
205
|
constructor(_client: Client);
|
|
@@ -104,6 +262,106 @@ export declare class InternalCustomersCharges {
|
|
|
104
262
|
*/
|
|
105
263
|
create(request: CreateCustomerChargesRequest, options?: RequestOptions): Promise<CreateCustomerChargesResponse>;
|
|
106
264
|
}
|
|
265
|
+
export declare class InternalEntitlements {
|
|
266
|
+
private readonly _client;
|
|
267
|
+
constructor(_client: Client);
|
|
268
|
+
/**
|
|
269
|
+
* Get customer entitlement access
|
|
270
|
+
*
|
|
271
|
+
* Get the customer's access to a single feature.
|
|
272
|
+
*
|
|
273
|
+
* GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
|
|
274
|
+
*/
|
|
275
|
+
getCustomerAccess(request: GetCustomerEntitlementAccessRequest, options?: RequestOptions): Promise<GetCustomerEntitlementAccessResponse>;
|
|
276
|
+
/**
|
|
277
|
+
* Get customer entitlement value by feature key
|
|
278
|
+
*
|
|
279
|
+
* Get the customer's entitlement value for a feature at a point in time. Without
|
|
280
|
+
* an active entitlement, the result denies access and omits the type.
|
|
281
|
+
*
|
|
282
|
+
* GET /openmeter/customers/{customerId}/entitlement-access/features/{featureKey}/value
|
|
283
|
+
*/
|
|
284
|
+
getCustomerValueByFeatureKey(request: GetCustomerEntitlementValueByFeatureKeyRequest, options?: RequestOptions): Promise<GetCustomerEntitlementValueByFeatureKeyResponse>;
|
|
285
|
+
/**
|
|
286
|
+
* List entitlements
|
|
287
|
+
*
|
|
288
|
+
* List the active entitlements of all customers. Intended for administrative use.
|
|
289
|
+
* To list the entitlements of a single customer, use the customer entitlements
|
|
290
|
+
* endpoints; to check entitlement access, use the entitlement access endpoints.
|
|
291
|
+
*
|
|
292
|
+
* GET /openmeter/entitlements
|
|
293
|
+
*/
|
|
294
|
+
list(request?: ListEntitlementsRequest, options?: RequestOptions): Promise<ListEntitlementsResponse>;
|
|
295
|
+
/**
|
|
296
|
+
* List entitlements
|
|
297
|
+
*
|
|
298
|
+
* List the active entitlements of all customers. Intended for administrative use.
|
|
299
|
+
* To list the entitlements of a single customer, use the customer entitlements
|
|
300
|
+
* endpoints; to check entitlement access, use the entitlement access endpoints.
|
|
301
|
+
*
|
|
302
|
+
* Iterates every item across all pages, fetching more as the returned iterable is consumed.
|
|
303
|
+
*
|
|
304
|
+
* GET /openmeter/entitlements
|
|
305
|
+
*/
|
|
306
|
+
listAll(request?: ListEntitlementsRequest, options?: RequestOptions): AsyncIterable<Entitlement>;
|
|
307
|
+
/**
|
|
308
|
+
* Get entitlement
|
|
309
|
+
*
|
|
310
|
+
* Get an entitlement by ID. To check entitlement access, use the entitlement
|
|
311
|
+
* access endpoints instead.
|
|
312
|
+
*
|
|
313
|
+
* GET /openmeter/entitlements/{entitlementId}
|
|
314
|
+
*/
|
|
315
|
+
get(request: GetEntitlementRequest, options?: RequestOptions): Promise<GetEntitlementResponse>;
|
|
316
|
+
/**
|
|
317
|
+
* Get customer entitlement value
|
|
318
|
+
*
|
|
319
|
+
* Get the customer's access through a single entitlement, optionally evaluated at
|
|
320
|
+
* a point in time.
|
|
321
|
+
*
|
|
322
|
+
* GET /openmeter/customers/{customerId}/entitlements/{entitlementId}/value
|
|
323
|
+
*/
|
|
324
|
+
getCustomerValue(request: GetCustomerEntitlementValueRequest, options?: RequestOptions): Promise<GetCustomerEntitlementValueResponse>;
|
|
325
|
+
}
|
|
326
|
+
export declare class InternalGrants {
|
|
327
|
+
private readonly _client;
|
|
328
|
+
constructor(_client: Client);
|
|
329
|
+
/**
|
|
330
|
+
* List grants
|
|
331
|
+
*
|
|
332
|
+
* List the grants of all customers and entitlements. To list the grants of a
|
|
333
|
+
* single entitlement, use the customer entitlement grants endpoint.
|
|
334
|
+
*
|
|
335
|
+
* Deleted grants are excluded unless `include_deleted` is set. Voided and expired
|
|
336
|
+
* grants are always included, as they are part of the balance history.
|
|
337
|
+
*
|
|
338
|
+
* GET /openmeter/grants
|
|
339
|
+
*/
|
|
340
|
+
list(request?: ListGrantsRequest, options?: RequestOptions): Promise<ListGrantsResponse>;
|
|
341
|
+
/**
|
|
342
|
+
* List grants
|
|
343
|
+
*
|
|
344
|
+
* List the grants of all customers and entitlements. To list the grants of a
|
|
345
|
+
* single entitlement, use the customer entitlement grants endpoint.
|
|
346
|
+
*
|
|
347
|
+
* Deleted grants are excluded unless `include_deleted` is set. Voided and expired
|
|
348
|
+
* grants are always included, as they are part of the balance history.
|
|
349
|
+
*
|
|
350
|
+
* Iterates every item across all pages, fetching more as the returned iterable is consumed.
|
|
351
|
+
*
|
|
352
|
+
* GET /openmeter/grants
|
|
353
|
+
*/
|
|
354
|
+
listAll(request?: ListGrantsRequest, options?: RequestOptions): AsyncIterable<EntitlementGrant>;
|
|
355
|
+
/**
|
|
356
|
+
* Void grant
|
|
357
|
+
*
|
|
358
|
+
* Void a grant so it no longer adds to the balance. Usage already deducted from
|
|
359
|
+
* the grant is kept.
|
|
360
|
+
*
|
|
361
|
+
* DELETE /openmeter/grants/{grantId}
|
|
362
|
+
*/
|
|
363
|
+
void(request: VoidGrantRequest, options?: RequestOptions): Promise<VoidGrantResponse>;
|
|
364
|
+
}
|
|
107
365
|
export declare class InternalSubscriptions {
|
|
108
366
|
private readonly _client;
|
|
109
367
|
constructor(_client: Client);
|
|
@@ -145,6 +403,14 @@ export declare class InternalSubscriptions {
|
|
|
145
403
|
* POST /openmeter/subscriptions/{subscriptionId}/migrate
|
|
146
404
|
*/
|
|
147
405
|
migrate(request: MigrateSubscriptionRequest, options?: RequestOptions): Promise<MigrateSubscriptionResponse>;
|
|
406
|
+
/**
|
|
407
|
+
* Create a new subscription add-on
|
|
408
|
+
*
|
|
409
|
+
* Add add-on to a subscription.
|
|
410
|
+
*
|
|
411
|
+
* POST /openmeter/subscriptions/{subscriptionId}/addons
|
|
412
|
+
*/
|
|
413
|
+
createAddon(request: CreateSubscriptionAddonRequest, options?: RequestOptions): Promise<CreateSubscriptionAddonResponse>;
|
|
148
414
|
/**
|
|
149
415
|
* Update subscription addon
|
|
150
416
|
*
|
|
@@ -159,24 +425,6 @@ export declare class InternalSubscriptions {
|
|
|
159
425
|
export declare class InternalApps {
|
|
160
426
|
private readonly _client;
|
|
161
427
|
constructor(_client: Client);
|
|
162
|
-
/**
|
|
163
|
-
* List apps
|
|
164
|
-
*
|
|
165
|
-
* List installed apps.
|
|
166
|
-
*
|
|
167
|
-
* GET /openmeter/apps
|
|
168
|
-
*/
|
|
169
|
-
list(request?: ListAppsRequest, options?: RequestOptions): Promise<ListAppsResponse>;
|
|
170
|
-
/**
|
|
171
|
-
* List apps
|
|
172
|
-
*
|
|
173
|
-
* List installed apps.
|
|
174
|
-
*
|
|
175
|
-
* Iterates every item across all pages, fetching more as the returned iterable is consumed.
|
|
176
|
-
*
|
|
177
|
-
* GET /openmeter/apps
|
|
178
|
-
*/
|
|
179
|
-
listAll(request?: ListAppsRequest, options?: RequestOptions): AsyncIterable<App>;
|
|
180
428
|
/**
|
|
181
429
|
* Uninstall app
|
|
182
430
|
*
|
|
@@ -487,3 +735,57 @@ export declare class InternalEntitlementAccess {
|
|
|
487
735
|
*/
|
|
488
736
|
query(request: QueryEntitlementAccessRequest, options?: RequestOptions): Promise<QueryEntitlementAccessResponse>;
|
|
489
737
|
}
|
|
738
|
+
export declare class InternalNotifications {
|
|
739
|
+
private readonly _client;
|
|
740
|
+
constructor(_client: Client);
|
|
741
|
+
/**
|
|
742
|
+
* List notification channels
|
|
743
|
+
*
|
|
744
|
+
* List all notification channels.
|
|
745
|
+
*
|
|
746
|
+
* GET /openmeter/notification/channels
|
|
747
|
+
*/
|
|
748
|
+
listChannels(request?: ListNotificationChannelsRequest, options?: RequestOptions): Promise<ListNotificationChannelsResponse>;
|
|
749
|
+
/**
|
|
750
|
+
* List notification channels
|
|
751
|
+
*
|
|
752
|
+
* List all notification channels.
|
|
753
|
+
*
|
|
754
|
+
* Iterates every item across all pages, fetching more as the returned iterable is consumed.
|
|
755
|
+
*
|
|
756
|
+
* GET /openmeter/notification/channels
|
|
757
|
+
*/
|
|
758
|
+
listChannelsAll(request?: ListNotificationChannelsRequest, options?: RequestOptions): AsyncIterable<NotificationChannel>;
|
|
759
|
+
/**
|
|
760
|
+
* Create notification channel
|
|
761
|
+
*
|
|
762
|
+
* Create a notification channel.
|
|
763
|
+
*
|
|
764
|
+
* POST /openmeter/notification/channels
|
|
765
|
+
*/
|
|
766
|
+
createChannel(request: CreateNotificationChannelRequest, options?: RequestOptions): Promise<CreateNotificationChannelResponse>;
|
|
767
|
+
/**
|
|
768
|
+
* Get notification channel
|
|
769
|
+
*
|
|
770
|
+
* Get a notification channel by id.
|
|
771
|
+
*
|
|
772
|
+
* GET /openmeter/notification/channels/{notificationChannelId}
|
|
773
|
+
*/
|
|
774
|
+
getChannel(request: GetNotificationChannelRequest, options?: RequestOptions): Promise<GetNotificationChannelResponse>;
|
|
775
|
+
/**
|
|
776
|
+
* Update notification channel
|
|
777
|
+
*
|
|
778
|
+
* Update a notification channel by id.
|
|
779
|
+
*
|
|
780
|
+
* PUT /openmeter/notification/channels/{notificationChannelId}
|
|
781
|
+
*/
|
|
782
|
+
updateChannel(request: UpdateNotificationChannelRequest, options?: RequestOptions): Promise<UpdateNotificationChannelResponse>;
|
|
783
|
+
/**
|
|
784
|
+
* Delete notification channel
|
|
785
|
+
*
|
|
786
|
+
* Delete a notification channel by id.
|
|
787
|
+
*
|
|
788
|
+
* DELETE /openmeter/notification/channels/{notificationChannelId}
|
|
789
|
+
*/
|
|
790
|
+
deleteChannel(request: DeleteNotificationChannelRequest, options?: RequestOptions): Promise<DeleteNotificationChannelResponse>;
|
|
791
|
+
}
|