@openmeter/sdk 1.0.0-beta-aeebf31bddfe → 1.0.0-beta-0fc95fcca441
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/dist/cjs/src/client/customers.cjs +9 -2
- package/dist/cjs/src/client/customers.d.cts +9 -2
- package/dist/cjs/src/client/customers.js.map +1 -1
- package/dist/cjs/src/client/entitlements.d.cts +2 -0
- package/dist/cjs/src/client/notifications.d.cts +3 -30
- package/dist/cjs/src/client/portal.js.map +1 -1
- package/dist/cjs/src/client/schemas.d.cts +123 -32
- package/dist/cjs/{tsconfig.78f62d2c.tsbuildinfo → tsconfig.6685ecce.tsbuildinfo} +1 -1
- package/dist/cjs/{tsconfig.e2f5e70e.tsbuildinfo → tsconfig.c55021b5.tsbuildinfo} +1 -1
- package/dist/src/client/customers.d.ts +9 -2
- package/dist/src/client/customers.js +9 -2
- package/dist/src/client/customers.js.map +1 -1
- package/dist/src/client/entitlements.d.ts +2 -0
- package/dist/src/client/notifications.d.ts +3 -30
- package/dist/src/client/portal.js.map +1 -1
- package/dist/src/client/schemas.d.ts +123 -32
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -127,7 +127,7 @@ class CustomerApps {
|
|
|
127
127
|
}
|
|
128
128
|
/**
|
|
129
129
|
* List customer app data
|
|
130
|
-
* @param customerIdOrKey - The ID or
|
|
130
|
+
* @param customerIdOrKey - The ID or key of the customer
|
|
131
131
|
* @param query - The query parameters
|
|
132
132
|
* @param signal - An optional abort signal
|
|
133
133
|
* @returns The list of customer app data
|
|
@@ -144,7 +144,7 @@ class CustomerApps {
|
|
|
144
144
|
}
|
|
145
145
|
/**
|
|
146
146
|
* Delete customer app data
|
|
147
|
-
* @param customerIdOrKey - The ID or
|
|
147
|
+
* @param customerIdOrKey - The ID or key of the customer
|
|
148
148
|
* @param appId - The ID of the app
|
|
149
149
|
* @param signal - An optional abort signal
|
|
150
150
|
* @returns The deleted customer app data
|
|
@@ -156,6 +156,13 @@ class CustomerApps {
|
|
|
156
156
|
});
|
|
157
157
|
return (0, utils_js_1.transformResponse)(resp);
|
|
158
158
|
}
|
|
159
|
+
/**
|
|
160
|
+
* List customer subscriptions
|
|
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 subscriptions
|
|
165
|
+
*/
|
|
159
166
|
async listSubscriptions(customerIdOrKey, query, options) {
|
|
160
167
|
const resp = await this.client.GET('/api/v1/customers/{customerIdOrKey}/subscriptions', {
|
|
161
168
|
params: { path: { customerIdOrKey }, query },
|
|
@@ -120,7 +120,7 @@ export declare class CustomerApps {
|
|
|
120
120
|
})[]>;
|
|
121
121
|
/**
|
|
122
122
|
* List customer app data
|
|
123
|
-
* @param customerIdOrKey - The ID or
|
|
123
|
+
* @param customerIdOrKey - The ID or key of the customer
|
|
124
124
|
* @param query - The query parameters
|
|
125
125
|
* @param signal - An optional abort signal
|
|
126
126
|
* @returns The list of customer app data
|
|
@@ -133,12 +133,19 @@ export declare class CustomerApps {
|
|
|
133
133
|
}>;
|
|
134
134
|
/**
|
|
135
135
|
* Delete customer app data
|
|
136
|
-
* @param customerIdOrKey - The ID or
|
|
136
|
+
* @param customerIdOrKey - The ID or key of the customer
|
|
137
137
|
* @param appId - The ID of the app
|
|
138
138
|
* @param signal - An optional abort signal
|
|
139
139
|
* @returns The deleted customer app data
|
|
140
140
|
*/
|
|
141
141
|
delete(customerIdOrKey: operations['deleteCustomerAppData']['parameters']['path']['customerIdOrKey'], appId: operations['deleteCustomerAppData']['parameters']['path']['appId'], options?: RequestOptions): Promise<undefined>;
|
|
142
|
+
/**
|
|
143
|
+
* List customer subscriptions
|
|
144
|
+
* @param customerIdOrKey - The ID or key of the customer
|
|
145
|
+
* @param query - The query parameters
|
|
146
|
+
* @param signal - An optional abort signal
|
|
147
|
+
* @returns The list of customer subscriptions
|
|
148
|
+
*/
|
|
142
149
|
listSubscriptions(customerIdOrKey: operations['listCustomerSubscriptions']['parameters']['path']['customerIdOrKey'], query?: operations['listCustomerSubscriptions']['parameters']['query'], options?: RequestOptions): Promise<{
|
|
143
150
|
totalCount: number;
|
|
144
151
|
page: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../../../src/client/customers.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAW9C;;;GAGG;AACH,MAAa,SAAS;IAIA;IAHb,IAAI,CAAc;IAClB,YAAY,CAAsB;IAEzC,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;QAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAA;IACtD,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,
|
|
1
|
+
{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../../../src/client/customers.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAW9C;;;GAGG;AACH,MAAa,SAAS;IAIA;IAHb,IAAI,CAAc;IAClB,YAAY,CAAsB;IAEzC,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;QAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAA;QACpC,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAA;IACtD,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAlHD,8BAkHC;AAED;;;GAGG;AACH,MAAa,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,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,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAtGD,oCAsGC;AAED;;GAEG;AACH,MAAa,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,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AAzBD,oDAyBC"}
|
|
@@ -114,16 +114,7 @@ export declare class NotificationRules {
|
|
|
114
114
|
* @returns The created rule
|
|
115
115
|
*/
|
|
116
116
|
create(rule: NotificationRuleCreateRequest, options?: RequestOptions): Promise<{
|
|
117
|
-
|
|
118
|
-
readonly updatedAt: Date;
|
|
119
|
-
readonly deletedAt?: Date;
|
|
120
|
-
readonly id: string;
|
|
121
|
-
type: "entitlements.balance.threshold";
|
|
122
|
-
name: string;
|
|
123
|
-
disabled?: boolean;
|
|
124
|
-
channels: import("./schemas.cjs").components["schemas"]["NotificationChannelMeta"][];
|
|
125
|
-
thresholds: import("./schemas.cjs").components["schemas"]["NotificationRuleBalanceThresholdValue"][];
|
|
126
|
-
features?: import("./schemas.cjs").components["schemas"]["FeatureMeta"][];
|
|
117
|
+
'application/json': import("./schemas.cjs").components["schemas"]["NotificationRule"];
|
|
127
118
|
}>;
|
|
128
119
|
/**
|
|
129
120
|
* Get a notification rule by ID
|
|
@@ -132,16 +123,7 @@ export declare class NotificationRules {
|
|
|
132
123
|
* @returns The notification rule
|
|
133
124
|
*/
|
|
134
125
|
get(id: operations['getNotificationRule']['parameters']['path']['ruleId'], options?: RequestOptions): Promise<{
|
|
135
|
-
|
|
136
|
-
readonly updatedAt: Date;
|
|
137
|
-
readonly deletedAt?: Date;
|
|
138
|
-
readonly id: string;
|
|
139
|
-
type: "entitlements.balance.threshold";
|
|
140
|
-
name: string;
|
|
141
|
-
disabled?: boolean;
|
|
142
|
-
channels: import("./schemas.cjs").components["schemas"]["NotificationChannelMeta"][];
|
|
143
|
-
thresholds: import("./schemas.cjs").components["schemas"]["NotificationRuleBalanceThresholdValue"][];
|
|
144
|
-
features?: import("./schemas.cjs").components["schemas"]["FeatureMeta"][];
|
|
126
|
+
'application/json': import("./schemas.cjs").components["schemas"]["NotificationRule"];
|
|
145
127
|
}>;
|
|
146
128
|
/**
|
|
147
129
|
* Update a notification rule
|
|
@@ -151,16 +133,7 @@ export declare class NotificationRules {
|
|
|
151
133
|
* @returns The updated rule
|
|
152
134
|
*/
|
|
153
135
|
update(id: operations['updateNotificationRule']['parameters']['path']['ruleId'], rule: NotificationRuleCreateRequest, options?: RequestOptions): Promise<{
|
|
154
|
-
|
|
155
|
-
readonly updatedAt: Date;
|
|
156
|
-
readonly deletedAt?: Date;
|
|
157
|
-
readonly id: string;
|
|
158
|
-
type: "entitlements.balance.threshold";
|
|
159
|
-
name: string;
|
|
160
|
-
disabled?: boolean;
|
|
161
|
-
channels: import("./schemas.cjs").components["schemas"]["NotificationChannelMeta"][];
|
|
162
|
-
thresholds: import("./schemas.cjs").components["schemas"]["NotificationRuleBalanceThresholdValue"][];
|
|
163
|
-
features?: import("./schemas.cjs").components["schemas"]["FeatureMeta"][];
|
|
136
|
+
'application/json': import("./schemas.cjs").components["schemas"]["NotificationRule"];
|
|
164
137
|
}>;
|
|
165
138
|
/**
|
|
166
139
|
* List notification rules
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"portal.js","sourceRoot":"","sources":["../../../../src/client/portal.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAK9C;;;GAGG;AACH,MAAa,MAAM;IACG;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;
|
|
1
|
+
{"version":3,"file":"portal.js","sourceRoot":"","sources":["../../../../src/client/portal.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAK9C;;;GAGG;AACH,MAAa,MAAM;IACG;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,IAAiB,EAAE,OAAwB;QAC7D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,KAA6D,EAC7D,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE;YAC1D,MAAM,EAAE,EAAE,KAAK,EAAE;YACjB,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CACrB,IAAwF,EACxF,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kCAAkC,EAAE;YACtE,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AArDD,wBAqDC"}
|
|
@@ -3306,8 +3306,7 @@ export interface components {
|
|
|
3306
3306
|
*/
|
|
3307
3307
|
subjectKeys: string[];
|
|
3308
3308
|
};
|
|
3309
|
-
/** @description A discount on a price.
|
|
3310
|
-
* One of: percentage, amount, or usage. */
|
|
3309
|
+
/** @description A discount on a price. */
|
|
3311
3310
|
Discount: components['schemas']['DiscountPercentage'];
|
|
3312
3311
|
/** @description Percentage discount. */
|
|
3313
3312
|
DiscountPercentage: {
|
|
@@ -3329,6 +3328,36 @@ export interface components {
|
|
|
3329
3328
|
*/
|
|
3330
3329
|
rateCards?: string[];
|
|
3331
3330
|
};
|
|
3331
|
+
/** @description Dynamic price with spend commitments. */
|
|
3332
|
+
DynamicPriceWithCommitments: {
|
|
3333
|
+
/**
|
|
3334
|
+
* @description The type of the price. (enum property replaced by openapi-typescript)
|
|
3335
|
+
* @enum {string}
|
|
3336
|
+
*/
|
|
3337
|
+
type: 'dynamic';
|
|
3338
|
+
/**
|
|
3339
|
+
* The rate to apply to the base price to get the dynamic price
|
|
3340
|
+
* @description The rate to apply to the base price to get the dynamic price.
|
|
3341
|
+
*
|
|
3342
|
+
* Examples:
|
|
3343
|
+
* - 0.0: the price is zero
|
|
3344
|
+
* - 0.5: the price is 50% of the base price
|
|
3345
|
+
* - 1.0: the price is the same as the base price
|
|
3346
|
+
* - 1.5: the price is 150% of the base price
|
|
3347
|
+
* @default 1
|
|
3348
|
+
*/
|
|
3349
|
+
markupRate?: components['schemas']['Numeric'];
|
|
3350
|
+
/**
|
|
3351
|
+
* Minimum amount
|
|
3352
|
+
* @description The customer is committed to spend at least the amount.
|
|
3353
|
+
*/
|
|
3354
|
+
minimumAmount?: components['schemas']['Numeric'];
|
|
3355
|
+
/**
|
|
3356
|
+
* Maximum amount
|
|
3357
|
+
* @description The customer is limited to spend at most the amount.
|
|
3358
|
+
*/
|
|
3359
|
+
maximumAmount?: components['schemas']['Numeric'];
|
|
3360
|
+
};
|
|
3332
3361
|
/** @description Add a new item to a phase. */
|
|
3333
3362
|
EditSubscriptionAddItem: {
|
|
3334
3363
|
/**
|
|
@@ -3534,7 +3563,13 @@ export interface components {
|
|
|
3534
3563
|
currentUsagePeriod?: components['schemas']['Period'];
|
|
3535
3564
|
/** @description The defined usage period of the entitlement */
|
|
3536
3565
|
usagePeriod?: components['schemas']['RecurringPeriod'];
|
|
3537
|
-
} & WithRequired<components['schemas']['EntitlementBaseTemplate'], 'type' | 'createdAt' | 'updatedAt' | 'activeFrom' | 'id' | 'subjectKey' | 'featureKey' | 'featureId'
|
|
3566
|
+
} & (WithRequired<components['schemas']['EntitlementBaseTemplate'], 'type' | 'createdAt' | 'updatedAt' | 'activeFrom' | 'id' | 'subjectKey' | 'featureKey' | 'featureId'> & {
|
|
3567
|
+
/**
|
|
3568
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3569
|
+
* @enum {string}
|
|
3570
|
+
*/
|
|
3571
|
+
type: 'boolean';
|
|
3572
|
+
});
|
|
3538
3573
|
/** @description Create inputs for boolean entitlement */
|
|
3539
3574
|
EntitlementBooleanCreateInputs: {
|
|
3540
3575
|
/**
|
|
@@ -3553,7 +3588,10 @@ export interface components {
|
|
|
3553
3588
|
metadata?: components['schemas']['Metadata'];
|
|
3554
3589
|
/** @description The usage period associated with the entitlement. */
|
|
3555
3590
|
usagePeriod?: components['schemas']['RecurringPeriodCreateInput'];
|
|
3556
|
-
/**
|
|
3591
|
+
/**
|
|
3592
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3593
|
+
* @enum {string}
|
|
3594
|
+
*/
|
|
3557
3595
|
type: 'boolean';
|
|
3558
3596
|
};
|
|
3559
3597
|
/** @description Create inputs for entitlement */
|
|
@@ -3716,7 +3754,10 @@ export interface components {
|
|
|
3716
3754
|
/** @description Metered entitlements are useful for many different use cases, from setting up usage based access to implementing complex credit systems.
|
|
3717
3755
|
* Access is determined based on feature usage using a balance calculation (the "usage allowance" provided by the issued grants is "burnt down" by the usage). */
|
|
3718
3756
|
EntitlementMetered: {
|
|
3719
|
-
/**
|
|
3757
|
+
/**
|
|
3758
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3759
|
+
* @enum {string}
|
|
3760
|
+
*/
|
|
3720
3761
|
type: 'metered';
|
|
3721
3762
|
/**
|
|
3722
3763
|
* Soft limit
|
|
@@ -3847,7 +3888,10 @@ export interface components {
|
|
|
3847
3888
|
featureId?: string;
|
|
3848
3889
|
/** @description Additional metadata for the feature. */
|
|
3849
3890
|
metadata?: components['schemas']['Metadata'];
|
|
3850
|
-
/**
|
|
3891
|
+
/**
|
|
3892
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3893
|
+
* @enum {string}
|
|
3894
|
+
*/
|
|
3851
3895
|
type: 'metered';
|
|
3852
3896
|
/**
|
|
3853
3897
|
* Soft limit
|
|
@@ -3915,7 +3959,10 @@ export interface components {
|
|
|
3915
3959
|
};
|
|
3916
3960
|
/** @description A static entitlement. */
|
|
3917
3961
|
EntitlementStatic: {
|
|
3918
|
-
/**
|
|
3962
|
+
/**
|
|
3963
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3964
|
+
* @enum {string}
|
|
3965
|
+
*/
|
|
3919
3966
|
type: 'static';
|
|
3920
3967
|
/**
|
|
3921
3968
|
* Format: json
|
|
@@ -4008,7 +4055,10 @@ export interface components {
|
|
|
4008
4055
|
metadata?: components['schemas']['Metadata'];
|
|
4009
4056
|
/** @description The usage period associated with the entitlement. */
|
|
4010
4057
|
usagePeriod?: components['schemas']['RecurringPeriodCreateInput'];
|
|
4011
|
-
/**
|
|
4058
|
+
/**
|
|
4059
|
+
* @description discriminator enum property added by openapi-typescript
|
|
4060
|
+
* @enum {string}
|
|
4061
|
+
*/
|
|
4012
4062
|
type: 'static';
|
|
4013
4063
|
/**
|
|
4014
4064
|
* Format: json
|
|
@@ -4788,7 +4838,7 @@ export interface components {
|
|
|
4788
4838
|
/** @description Subscription are the references to the subscritpions that this line is related to. */
|
|
4789
4839
|
readonly subscriptions?: components['schemas']['InvoiceLineSubscriptionReference'];
|
|
4790
4840
|
/**
|
|
4791
|
-
* @description Type of the line.
|
|
4841
|
+
* @description Type of the line. (enum property replaced by openapi-typescript)
|
|
4792
4842
|
* @enum {string}
|
|
4793
4843
|
*/
|
|
4794
4844
|
type: 'flat_fee';
|
|
@@ -4839,7 +4889,7 @@ export interface components {
|
|
|
4839
4889
|
*/
|
|
4840
4890
|
invoiceAt: Date;
|
|
4841
4891
|
/**
|
|
4842
|
-
* @description Type of the line.
|
|
4892
|
+
* @description Type of the line. (enum property replaced by openapi-typescript)
|
|
4843
4893
|
* @enum {string}
|
|
4844
4894
|
*/
|
|
4845
4895
|
type: 'flat_fee';
|
|
@@ -4895,7 +4945,7 @@ export interface components {
|
|
|
4895
4945
|
*/
|
|
4896
4946
|
invoiceAt: Date;
|
|
4897
4947
|
/**
|
|
4898
|
-
* @description Type of the line.
|
|
4948
|
+
* @description Type of the line. (enum property replaced by openapi-typescript)
|
|
4899
4949
|
* @enum {string}
|
|
4900
4950
|
*/
|
|
4901
4951
|
type: 'flat_fee';
|
|
@@ -5168,7 +5218,7 @@ export interface components {
|
|
|
5168
5218
|
*/
|
|
5169
5219
|
invoiceAt: Date;
|
|
5170
5220
|
/**
|
|
5171
|
-
* @description Type of the line.
|
|
5221
|
+
* @description Type of the line. (enum property replaced by openapi-typescript)
|
|
5172
5222
|
* @enum {string}
|
|
5173
5223
|
*/
|
|
5174
5224
|
type: 'flat_fee';
|
|
@@ -5237,7 +5287,7 @@ export interface components {
|
|
|
5237
5287
|
*/
|
|
5238
5288
|
invoiceAt: Date;
|
|
5239
5289
|
/**
|
|
5240
|
-
* @description Type of the line.
|
|
5290
|
+
* @description Type of the line. (enum property replaced by openapi-typescript)
|
|
5241
5291
|
* @enum {string}
|
|
5242
5292
|
*/
|
|
5243
5293
|
type: 'usage_based';
|
|
@@ -5387,7 +5437,7 @@ export interface components {
|
|
|
5387
5437
|
/** @description Subscription are the references to the subscritpions that this line is related to. */
|
|
5388
5438
|
readonly subscriptions?: components['schemas']['InvoiceLineSubscriptionReference'];
|
|
5389
5439
|
/**
|
|
5390
|
-
* @description Type of the line.
|
|
5440
|
+
* @description Type of the line. (enum property replaced by openapi-typescript)
|
|
5391
5441
|
* @enum {string}
|
|
5392
5442
|
*/
|
|
5393
5443
|
type: 'usage_based';
|
|
@@ -5434,7 +5484,7 @@ export interface components {
|
|
|
5434
5484
|
*/
|
|
5435
5485
|
invoiceAt: Date;
|
|
5436
5486
|
/**
|
|
5437
|
-
* @description Type of the line.
|
|
5487
|
+
* @description Type of the line. (enum property replaced by openapi-typescript)
|
|
5438
5488
|
* @enum {string}
|
|
5439
5489
|
*/
|
|
5440
5490
|
type: 'usage_based';
|
|
@@ -5480,7 +5530,7 @@ export interface components {
|
|
|
5480
5530
|
*/
|
|
5481
5531
|
invoiceAt: Date;
|
|
5482
5532
|
/**
|
|
5483
|
-
* @description Type of the line.
|
|
5533
|
+
* @description Type of the line. (enum property replaced by openapi-typescript)
|
|
5484
5534
|
* @enum {string}
|
|
5485
5535
|
*/
|
|
5486
5536
|
type: 'usage_based';
|
|
@@ -5986,7 +6036,7 @@ export interface components {
|
|
|
5986
6036
|
* Channel Type
|
|
5987
6037
|
* @description Notification channel type.
|
|
5988
6038
|
*/
|
|
5989
|
-
|
|
6039
|
+
type: components['schemas']['NotificationChannelType'];
|
|
5990
6040
|
};
|
|
5991
6041
|
/**
|
|
5992
6042
|
* @description Order by options for notification channels.
|
|
@@ -6271,7 +6321,9 @@ export interface components {
|
|
|
6271
6321
|
*/
|
|
6272
6322
|
NotificationEventType: 'entitlements.balance.threshold';
|
|
6273
6323
|
/** @description Notification Rule. */
|
|
6274
|
-
NotificationRule:
|
|
6324
|
+
NotificationRule: {
|
|
6325
|
+
type: 'NotificationRule';
|
|
6326
|
+
} & components['schemas']['NotificationRuleBalanceThreshold'];
|
|
6275
6327
|
/** @description Notification rule with entitlements.balance.threshold type. */
|
|
6276
6328
|
NotificationRuleBalanceThreshold: {
|
|
6277
6329
|
/**
|
|
@@ -6395,7 +6447,9 @@ export interface components {
|
|
|
6395
6447
|
*/
|
|
6396
6448
|
NotificationRuleBalanceThresholdValueType: 'PERCENT' | 'NUMBER';
|
|
6397
6449
|
/** @description Union type for requests creating new notification rule with certain type. */
|
|
6398
|
-
NotificationRuleCreateRequest:
|
|
6450
|
+
NotificationRuleCreateRequest: {
|
|
6451
|
+
type: 'NotificationRuleCreateRequest';
|
|
6452
|
+
} & components['schemas']['NotificationRuleBalanceThresholdCreateRequest'];
|
|
6399
6453
|
/**
|
|
6400
6454
|
* @description Order by options for notification channels.
|
|
6401
6455
|
* @enum {string}
|
|
@@ -6428,6 +6482,34 @@ export interface components {
|
|
|
6428
6482
|
* @enum {string}
|
|
6429
6483
|
*/
|
|
6430
6484
|
OAuth2AuthorizationCodeGrantErrorType: 'invalid_request' | 'unauthorized_client' | 'access_denied' | 'unsupported_response_type' | 'invalid_scope' | 'server_error' | 'temporarily_unavailable';
|
|
6485
|
+
/** @description Package price with spend commitments. */
|
|
6486
|
+
PackagePriceWithCommitments: {
|
|
6487
|
+
/**
|
|
6488
|
+
* @description The type of the price. (enum property replaced by openapi-typescript)
|
|
6489
|
+
* @enum {string}
|
|
6490
|
+
*/
|
|
6491
|
+
type: 'package';
|
|
6492
|
+
/**
|
|
6493
|
+
* Amount
|
|
6494
|
+
* @description The price of one package.
|
|
6495
|
+
*/
|
|
6496
|
+
amount: components['schemas']['Numeric'];
|
|
6497
|
+
/**
|
|
6498
|
+
* Quantity per package
|
|
6499
|
+
* @description The quantity per package.
|
|
6500
|
+
*/
|
|
6501
|
+
quantityPerPackage: components['schemas']['Numeric'];
|
|
6502
|
+
/**
|
|
6503
|
+
* Minimum amount
|
|
6504
|
+
* @description The customer is committed to spend at least the amount.
|
|
6505
|
+
*/
|
|
6506
|
+
minimumAmount?: components['schemas']['Numeric'];
|
|
6507
|
+
/**
|
|
6508
|
+
* Maximum amount
|
|
6509
|
+
* @description The customer is limited to spend at most the amount.
|
|
6510
|
+
*/
|
|
6511
|
+
maximumAmount?: components['schemas']['Numeric'];
|
|
6512
|
+
};
|
|
6431
6513
|
/** @description PaymentDueDate contains an amount that should be paid by the given date. */
|
|
6432
6514
|
PaymentDueDate: {
|
|
6433
6515
|
/**
|
|
@@ -6880,7 +6962,10 @@ export interface components {
|
|
|
6880
6962
|
RateCardBooleanEntitlement: {
|
|
6881
6963
|
/** @description Additional metadata for the feature. */
|
|
6882
6964
|
metadata?: components['schemas']['Metadata'];
|
|
6883
|
-
/**
|
|
6965
|
+
/**
|
|
6966
|
+
* @description discriminator enum property added by openapi-typescript
|
|
6967
|
+
* @enum {string}
|
|
6968
|
+
*/
|
|
6884
6969
|
type: 'boolean';
|
|
6885
6970
|
};
|
|
6886
6971
|
/** @description Entitlement templates are used to define the entitlements of a plan.
|
|
@@ -6950,7 +7035,10 @@ export interface components {
|
|
|
6950
7035
|
RateCardMeteredEntitlement: {
|
|
6951
7036
|
/** @description Additional metadata for the feature. */
|
|
6952
7037
|
metadata?: components['schemas']['Metadata'];
|
|
6953
|
-
/**
|
|
7038
|
+
/**
|
|
7039
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7040
|
+
* @enum {string}
|
|
7041
|
+
*/
|
|
6954
7042
|
type: 'metered';
|
|
6955
7043
|
/**
|
|
6956
7044
|
* Soft limit
|
|
@@ -6992,7 +7080,10 @@ export interface components {
|
|
|
6992
7080
|
RateCardStaticEntitlement: {
|
|
6993
7081
|
/** @description Additional metadata for the feature. */
|
|
6994
7082
|
metadata?: components['schemas']['Metadata'];
|
|
6995
|
-
/**
|
|
7083
|
+
/**
|
|
7084
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7085
|
+
* @enum {string}
|
|
7086
|
+
*/
|
|
6996
7087
|
type: 'static';
|
|
6997
7088
|
/**
|
|
6998
7089
|
* Format: json
|
|
@@ -7053,7 +7144,7 @@ export interface components {
|
|
|
7053
7144
|
price: components['schemas']['RateCardUsageBasedPrice'] | null;
|
|
7054
7145
|
};
|
|
7055
7146
|
/** @description The price of the usage based rate card. */
|
|
7056
|
-
RateCardUsageBasedPrice: components['schemas']['FlatPriceWithPaymentTerm'] | components['schemas']['UnitPriceWithCommitments'] | components['schemas']['TieredPriceWithCommitments'];
|
|
7147
|
+
RateCardUsageBasedPrice: components['schemas']['FlatPriceWithPaymentTerm'] | components['schemas']['UnitPriceWithCommitments'] | components['schemas']['TieredPriceWithCommitments'] | components['schemas']['DynamicPriceWithCommitments'] | components['schemas']['PackagePriceWithCommitments'];
|
|
7057
7148
|
/**
|
|
7058
7149
|
* @description Recurring period with an interval and an anchor.
|
|
7059
7150
|
* @example {
|
|
@@ -7187,7 +7278,7 @@ export interface components {
|
|
|
7187
7278
|
* Only one app of each type can be default. */
|
|
7188
7279
|
default: boolean;
|
|
7189
7280
|
/**
|
|
7190
|
-
* @description The app's type is Sandbox.
|
|
7281
|
+
* @description The app's type is Sandbox. (enum property replaced by openapi-typescript)
|
|
7191
7282
|
* @enum {string}
|
|
7192
7283
|
*/
|
|
7193
7284
|
type: 'sandbox';
|
|
@@ -7204,8 +7295,7 @@ export interface components {
|
|
|
7204
7295
|
*/
|
|
7205
7296
|
id?: string;
|
|
7206
7297
|
/**
|
|
7207
|
-
*
|
|
7208
|
-
* @description The app name.
|
|
7298
|
+
* @description The app name. (enum property replaced by openapi-typescript)
|
|
7209
7299
|
* @enum {string}
|
|
7210
7300
|
*/
|
|
7211
7301
|
type: 'sandbox';
|
|
@@ -7313,7 +7403,7 @@ export interface components {
|
|
|
7313
7403
|
* Only one app of each type can be default. */
|
|
7314
7404
|
default: boolean;
|
|
7315
7405
|
/**
|
|
7316
|
-
* @description The app's type is Stripe.
|
|
7406
|
+
* @description The app's type is Stripe. (enum property replaced by openapi-typescript)
|
|
7317
7407
|
* @enum {string}
|
|
7318
7408
|
*/
|
|
7319
7409
|
type: 'stripe';
|
|
@@ -7346,8 +7436,7 @@ export interface components {
|
|
|
7346
7436
|
*/
|
|
7347
7437
|
id?: string;
|
|
7348
7438
|
/**
|
|
7349
|
-
*
|
|
7350
|
-
* @description The app name.
|
|
7439
|
+
* @description The app name. (enum property replaced by openapi-typescript)
|
|
7351
7440
|
* @enum {string}
|
|
7352
7441
|
*/
|
|
7353
7442
|
type: 'stripe';
|
|
@@ -8163,7 +8252,7 @@ export interface components {
|
|
|
8163
8252
|
/** @description VoidInvoiceLineDiscardAction describes how to handle the voidied line item in the invoice. */
|
|
8164
8253
|
VoidInvoiceLineDiscardAction: {
|
|
8165
8254
|
/**
|
|
8166
|
-
* @description The action to take on the line item.
|
|
8255
|
+
* @description The action to take on the line item. (enum property replaced by openapi-typescript)
|
|
8167
8256
|
* @enum {string}
|
|
8168
8257
|
*/
|
|
8169
8258
|
type: 'discard';
|
|
@@ -8171,7 +8260,7 @@ export interface components {
|
|
|
8171
8260
|
/** @description VoidInvoiceLinePendingAction describes how to handle the voidied line item in the invoice. */
|
|
8172
8261
|
VoidInvoiceLinePendingActionCreate: {
|
|
8173
8262
|
/**
|
|
8174
|
-
* @description The action to take on the line item.
|
|
8263
|
+
* @description The action to take on the line item. (enum property replaced by openapi-typescript)
|
|
8175
8264
|
* @enum {string}
|
|
8176
8265
|
*/
|
|
8177
8266
|
type: 'pending';
|
|
@@ -8187,7 +8276,7 @@ export interface components {
|
|
|
8187
8276
|
/** @description VoidInvoiceLinePendingAction describes how to handle the voidied line item in the invoice. */
|
|
8188
8277
|
VoidInvoiceLinePendingActionCreateItem: {
|
|
8189
8278
|
/**
|
|
8190
|
-
* @description The action to take on the line item.
|
|
8279
|
+
* @description The action to take on the line item. (enum property replaced by openapi-typescript)
|
|
8191
8280
|
* @enum {string}
|
|
8192
8281
|
*/
|
|
8193
8282
|
type: 'pending';
|
|
@@ -8492,6 +8581,7 @@ export type CustomerReplaceUpdate = components['schemas']['CustomerReplaceUpdate
|
|
|
8492
8581
|
export type CustomerUsageAttribution = components['schemas']['CustomerUsageAttribution'];
|
|
8493
8582
|
export type Discount = components['schemas']['Discount'];
|
|
8494
8583
|
export type DiscountPercentage = components['schemas']['DiscountPercentage'];
|
|
8584
|
+
export type DynamicPriceWithCommitments = components['schemas']['DynamicPriceWithCommitments'];
|
|
8495
8585
|
export type EditSubscriptionAddItem = components['schemas']['EditSubscriptionAddItem'];
|
|
8496
8586
|
export type EditSubscriptionAddPhase = components['schemas']['EditSubscriptionAddPhase'];
|
|
8497
8587
|
export type EditSubscriptionRemoveItem = components['schemas']['EditSubscriptionRemoveItem'];
|
|
@@ -8626,6 +8716,7 @@ export type NotificationRuleOrderBy = components['schemas']['NotificationRuleOrd
|
|
|
8626
8716
|
export type NotificationRulePaginatedResponse = components['schemas']['NotificationRulePaginatedResponse'];
|
|
8627
8717
|
export type Numeric = components['schemas']['Numeric'];
|
|
8628
8718
|
export type OAuth2AuthorizationCodeGrantErrorType = components['schemas']['OAuth2AuthorizationCodeGrantErrorType'];
|
|
8719
|
+
export type PackagePriceWithCommitments = components['schemas']['PackagePriceWithCommitments'];
|
|
8629
8720
|
export type PaymentDueDate = components['schemas']['PaymentDueDate'];
|
|
8630
8721
|
export type PaymentTermDueDate = components['schemas']['PaymentTermDueDate'];
|
|
8631
8722
|
export type PaymentTermInstant = components['schemas']['PaymentTermInstant'];
|