@openmeter/sdk 1.0.0-beta-0f4e99f7857e → 1.0.0-beta-1659b7d437ee
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/react/context.d.cts +1 -1
- package/dist/cjs/src/zod/index.cjs +286 -330
- package/dist/cjs/src/zod/index.cjs.map +1 -1
- package/dist/cjs/src/zod/index.d.cts +231 -244
- package/dist/src/react/context.d.ts +1 -1
- package/dist/src/zod/index.d.ts +231 -244
- package/dist/src/zod/index.js +267 -311
- package/dist/src/zod/index.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +12 -12
package/dist/src/zod/index.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Generated by orval v8.
|
|
2
|
+
* Generated by orval v8.15.0 🍺
|
|
3
3
|
* Do not edit manually.
|
|
4
4
|
* OpenMeter Cloud API
|
|
5
5
|
* OpenMeter is a cloud native usage metering service.
|
|
6
|
-
The OpenMeter API allows you to ingest events, query meter usage, and manage resources.
|
|
6
|
+
* The OpenMeter API allows you to ingest events, query meter usage, and manage resources.
|
|
7
7
|
* OpenAPI spec version: 1.0.0
|
|
8
8
|
*/
|
|
9
9
|
import * as zod from 'zod';
|
|
@@ -1309,8 +1309,8 @@ export const GetAddonQueryParams = zod.object({
|
|
|
1309
1309
|
});
|
|
1310
1310
|
/**
|
|
1311
1311
|
* Soft delete add-on by id.
|
|
1312
|
-
|
|
1313
|
-
Once a add-on is deleted it cannot be undeleted.
|
|
1312
|
+
*
|
|
1313
|
+
* Once a add-on is deleted it cannot be undeleted.
|
|
1314
1314
|
* @summary Delete add-on
|
|
1315
1315
|
*/
|
|
1316
1316
|
export const deleteAddonPathAddonIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1587,8 +1587,8 @@ export const UninstallAppParams = zod.object({
|
|
|
1587
1587
|
});
|
|
1588
1588
|
/**
|
|
1589
1589
|
* Update the Stripe API key.
|
|
1590
|
-
|
|
1591
|
-
⚠️ __Deprecated__: Use [`PUT /api/v1/apps/{id}`](#tag/apps/put/api/v1/apps/{id}) instead.
|
|
1590
|
+
*
|
|
1591
|
+
* ⚠️ __Deprecated__: Use [`PUT /api/v1/apps/{id}`](#tag/apps/put/api/v1/apps/{id}) instead.
|
|
1592
1592
|
* @deprecated
|
|
1593
1593
|
* @summary Update Stripe API key
|
|
1594
1594
|
*/
|
|
@@ -1624,12 +1624,12 @@ export const AppStripeWebhookBody = zod
|
|
|
1624
1624
|
.describe('Stripe webhook event.');
|
|
1625
1625
|
/**
|
|
1626
1626
|
* List customer overrides using the specified filters.
|
|
1627
|
-
|
|
1628
|
-
The response will include the customer override values and the merged billing profile values.
|
|
1629
|
-
|
|
1630
|
-
If the includeAllCustomers is set to true, the list contains all customers. This mode is
|
|
1631
|
-
useful for getting the current effective billing workflow settings for all users regardless
|
|
1632
|
-
if they have customer orverrides or not.
|
|
1627
|
+
*
|
|
1628
|
+
* The response will include the customer override values and the merged billing profile values.
|
|
1629
|
+
*
|
|
1630
|
+
* If the includeAllCustomers is set to true, the list contains all customers. This mode is
|
|
1631
|
+
* useful for getting the current effective billing workflow settings for all users regardless
|
|
1632
|
+
* if they have customer orverrides or not.
|
|
1633
1633
|
* @summary List customer overrides
|
|
1634
1634
|
*/
|
|
1635
1635
|
export const listBillingProfileCustomerOverridesQueryBillingProfileItemRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1709,10 +1709,10 @@ export const ListBillingProfileCustomerOverridesQueryParams = zod.object({
|
|
|
1709
1709
|
});
|
|
1710
1710
|
/**
|
|
1711
1711
|
* The customer override can be used to pin a given customer to a billing profile
|
|
1712
|
-
different from the default one.
|
|
1713
|
-
|
|
1714
|
-
This can be used to test the effect of different billing profiles before making them
|
|
1715
|
-
the default ones or have different workflow settings for example for enterprise customers.
|
|
1712
|
+
* different from the default one.
|
|
1713
|
+
*
|
|
1714
|
+
* This can be used to test the effect of different billing profiles before making them
|
|
1715
|
+
* the default ones or have different workflow settings for example for enterprise customers.
|
|
1716
1716
|
* @summary Create a new or update a customer override
|
|
1717
1717
|
*/
|
|
1718
1718
|
export const upsertBillingProfileCustomerOverridePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1733,11 +1733,11 @@ export const UpsertBillingProfileCustomerOverrideBody = zod
|
|
|
1733
1733
|
.describe('Payload for creating a new or updating an existing customer override.');
|
|
1734
1734
|
/**
|
|
1735
1735
|
* Get a customer override by customer id.
|
|
1736
|
-
|
|
1737
|
-
The response will include the customer override values and the merged billing profile values.
|
|
1738
|
-
|
|
1739
|
-
If the customer override is not found, the default billing profile's values are returned. This behavior
|
|
1740
|
-
allows for getting a merged profile regardless of the customer override existence.
|
|
1736
|
+
*
|
|
1737
|
+
* The response will include the customer override values and the merged billing profile values.
|
|
1738
|
+
*
|
|
1739
|
+
* If the customer override is not found, the default billing profile's values are returned. This behavior
|
|
1740
|
+
* allows for getting a merged profile regardless of the customer override existence.
|
|
1741
1741
|
* @summary Get a customer override
|
|
1742
1742
|
*/
|
|
1743
1743
|
export const getBillingProfileCustomerOverridePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1755,9 +1755,9 @@ export const GetBillingProfileCustomerOverrideQueryParams = zod.object({
|
|
|
1755
1755
|
});
|
|
1756
1756
|
/**
|
|
1757
1757
|
* Delete a customer override by customer id.
|
|
1758
|
-
|
|
1759
|
-
This will remove the customer override and the customer will be subject to the default
|
|
1760
|
-
billing profile's settings again.
|
|
1758
|
+
*
|
|
1759
|
+
* This will remove the customer override and the customer will be subject to the default
|
|
1760
|
+
* billing profile's settings again.
|
|
1761
1761
|
* @summary Delete a customer override
|
|
1762
1762
|
*/
|
|
1763
1763
|
export const deleteBillingProfileCustomerOverridePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1768,13 +1768,13 @@ export const DeleteBillingProfileCustomerOverrideParams = zod.object({
|
|
|
1768
1768
|
});
|
|
1769
1769
|
/**
|
|
1770
1770
|
* Create a new pending line item (charge).
|
|
1771
|
-
|
|
1772
|
-
This call is used to create a new pending line item for the customer if required a new
|
|
1773
|
-
gathering invoice will be created.
|
|
1774
|
-
|
|
1775
|
-
A new invoice will be created if:
|
|
1776
|
-
- there is no invoice in gathering state
|
|
1777
|
-
- the currency of the line item doesn't match the currency of any invoices in gathering state
|
|
1771
|
+
*
|
|
1772
|
+
* This call is used to create a new pending line item for the customer if required a new
|
|
1773
|
+
* gathering invoice will be created.
|
|
1774
|
+
*
|
|
1775
|
+
* A new invoice will be created if:
|
|
1776
|
+
* - there is no invoice in gathering state
|
|
1777
|
+
* - the currency of the line item doesn't match the currency of any invoices in gathering state
|
|
1778
1778
|
* @summary Create pending line items
|
|
1779
1779
|
*/
|
|
1780
1780
|
export const createPendingInvoiceLinePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -2333,10 +2333,10 @@ export const CreatePendingInvoiceLineBody = zod
|
|
|
2333
2333
|
.describe('InvoicePendingLineCreate represents the create model for a pending invoice line.');
|
|
2334
2334
|
/**
|
|
2335
2335
|
* Simulate an invoice for a customer.
|
|
2336
|
-
|
|
2337
|
-
This call will simulate an invoice for a customer based on the pending line items.
|
|
2338
|
-
|
|
2339
|
-
The call will return the total amount of the invoice and the line items that will be included in the invoice.
|
|
2336
|
+
*
|
|
2337
|
+
* This call will simulate an invoice for a customer based on the pending line items.
|
|
2338
|
+
*
|
|
2339
|
+
* The call will return the total amount of the invoice and the line items that will be included in the invoice.
|
|
2340
2340
|
* @summary Simulate an invoice for a customer
|
|
2341
2341
|
*/
|
|
2342
2342
|
export const simulateInvoicePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -2919,11 +2919,11 @@ export const SimulateInvoiceBody = zod
|
|
|
2919
2919
|
.describe('InvoiceSimulationInput is the input for simulating an invoice.');
|
|
2920
2920
|
/**
|
|
2921
2921
|
* List invoices based on the specified filters.
|
|
2922
|
-
|
|
2923
|
-
The expand option can be used to include additional information (besides the invoice header and totals)
|
|
2924
|
-
in the response. For example by adding the expand=lines option the invoice lines will be included in the response.
|
|
2925
|
-
|
|
2926
|
-
Gathering invoices will always show the current usage calculated on the fly.
|
|
2922
|
+
*
|
|
2923
|
+
* The expand option can be used to include additional information (besides the invoice header and totals)
|
|
2924
|
+
* in the response. For example by adding the expand=lines option the invoice lines will be included in the response.
|
|
2925
|
+
*
|
|
2926
|
+
* Gathering invoices will always show the current usage calculated on the fly.
|
|
2927
2927
|
* @summary List invoices
|
|
2928
2928
|
*/
|
|
2929
2929
|
export const listInvoicesQueryCustomersItemRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3023,14 +3023,14 @@ export const ListInvoicesQueryParams = zod.object({
|
|
|
3023
3023
|
});
|
|
3024
3024
|
/**
|
|
3025
3025
|
* Create a new invoice from the pending line items.
|
|
3026
|
-
|
|
3027
|
-
This should be only called if for some reason we need to invoice a customer outside of the normal billing cycle.
|
|
3028
|
-
|
|
3029
|
-
When creating an invoice, the pending line items will be marked as invoiced and the invoice will be created with the total amount of the pending items.
|
|
3030
|
-
|
|
3031
|
-
New pending line items will be created for the period between now() and the next billing cycle's begining date for any metered item.
|
|
3032
|
-
|
|
3033
|
-
The call can return multiple invoices if the pending line items are in different currencies.
|
|
3026
|
+
*
|
|
3027
|
+
* This should be only called if for some reason we need to invoice a customer outside of the normal billing cycle.
|
|
3028
|
+
*
|
|
3029
|
+
* When creating an invoice, the pending line items will be marked as invoiced and the invoice will be created with the total amount of the pending items.
|
|
3030
|
+
*
|
|
3031
|
+
* New pending line items will be created for the period between now() and the next billing cycle's begining date for any metered item.
|
|
3032
|
+
*
|
|
3033
|
+
* The call can return multiple invoices if the pending line items are in different currencies.
|
|
3034
3034
|
* @summary Invoice a customer based on the pending line items
|
|
3035
3035
|
*/
|
|
3036
3036
|
export const invoicePendingLinesActionBodyFiltersOneLineIdsItemRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3066,8 +3066,8 @@ export const InvoicePendingLinesActionBody = zod
|
|
|
3066
3066
|
.describe('BillingInvoiceActionInput is the input for creating an invoice.\n\nInvoice creation is always based on already pending line items created by the billingCreateLineByCustomer\noperation. Empty invoices are not allowed.');
|
|
3067
3067
|
/**
|
|
3068
3068
|
* Get an invoice by ID.
|
|
3069
|
-
|
|
3070
|
-
Gathering invoices will always show the current usage calculated on the fly.
|
|
3069
|
+
*
|
|
3070
|
+
* Gathering invoices will always show the current usage calculated on the fly.
|
|
3071
3071
|
* @summary Get an invoice
|
|
3072
3072
|
*/
|
|
3073
3073
|
export const getInvoicePathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3087,10 +3087,10 @@ export const GetInvoiceQueryParams = zod.object({
|
|
|
3087
3087
|
});
|
|
3088
3088
|
/**
|
|
3089
3089
|
* Delete an invoice
|
|
3090
|
-
|
|
3091
|
-
Only invoices that are in the draft (or earlier) status can be deleted.
|
|
3092
|
-
|
|
3093
|
-
Invoices that are post finalization can only be voided.
|
|
3090
|
+
*
|
|
3091
|
+
* Only invoices that are in the draft (or earlier) status can be deleted.
|
|
3092
|
+
*
|
|
3093
|
+
* Invoices that are post finalization can only be voided.
|
|
3094
3094
|
* @summary Delete an invoice
|
|
3095
3095
|
*/
|
|
3096
3096
|
export const deleteInvoicePathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3099,8 +3099,8 @@ export const DeleteInvoiceParams = zod.object({
|
|
|
3099
3099
|
});
|
|
3100
3100
|
/**
|
|
3101
3101
|
* Update an invoice
|
|
3102
|
-
|
|
3103
|
-
Only invoices in draft or earlier status can be updated.
|
|
3102
|
+
*
|
|
3103
|
+
* Only invoices in draft or earlier status can be updated.
|
|
3104
3104
|
* @summary Update an invoice
|
|
3105
3105
|
*/
|
|
3106
3106
|
export const updateInvoicePathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3883,10 +3883,10 @@ export const UpdateInvoiceBody = zod
|
|
|
3883
3883
|
.describe('InvoiceReplaceUpdate represents the update model for an invoice.');
|
|
3884
3884
|
/**
|
|
3885
3885
|
* Advance the invoice's state to the next status.
|
|
3886
|
-
|
|
3887
|
-
The call doesn't "approve the invoice", it only advances the invoice to the next status if the transition would be automatic.
|
|
3888
|
-
|
|
3889
|
-
The action can be called when the invoice's statusDetails' actions field contain the "advance" action.
|
|
3886
|
+
*
|
|
3887
|
+
* The call doesn't "approve the invoice", it only advances the invoice to the next status if the transition would be automatic.
|
|
3888
|
+
*
|
|
3889
|
+
* The action can be called when the invoice's statusDetails' actions field contain the "advance" action.
|
|
3890
3890
|
* @summary Advance the invoice's state to the next status
|
|
3891
3891
|
*/
|
|
3892
3892
|
export const advanceInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3895,12 +3895,12 @@ export const AdvanceInvoiceActionParams = zod.object({
|
|
|
3895
3895
|
});
|
|
3896
3896
|
/**
|
|
3897
3897
|
* Approve an invoice and start executing the payment workflow.
|
|
3898
|
-
|
|
3899
|
-
This call instantly sends the invoice to the customer using the configured billing profile app.
|
|
3900
|
-
|
|
3901
|
-
This call is valid in two invoice statuses:
|
|
3902
|
-
- `draft`: the invoice will be sent to the customer, the invluce state becomes issued
|
|
3903
|
-
- `manual_approval_needed`: the invoice will be sent to the customer, the invoice state becomes issued
|
|
3898
|
+
*
|
|
3899
|
+
* This call instantly sends the invoice to the customer using the configured billing profile app.
|
|
3900
|
+
*
|
|
3901
|
+
* This call is valid in two invoice statuses:
|
|
3902
|
+
* - `draft`: the invoice will be sent to the customer, the invluce state becomes issued
|
|
3903
|
+
* - `manual_approval_needed`: the invoice will be sent to the customer, the invoice state becomes issued
|
|
3904
3904
|
* @summary Send the invoice to the customer
|
|
3905
3905
|
*/
|
|
3906
3906
|
export const approveInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3909,8 +3909,8 @@ export const ApproveInvoiceActionParams = zod.object({
|
|
|
3909
3909
|
});
|
|
3910
3910
|
/**
|
|
3911
3911
|
* Retry advancing the invoice after a failed attempt.
|
|
3912
|
-
|
|
3913
|
-
The action can be called when the invoice's statusDetails' actions field contain the "retry" action.
|
|
3912
|
+
*
|
|
3913
|
+
* The action can be called when the invoice's statusDetails' actions field contain the "retry" action.
|
|
3914
3914
|
* @summary Retry advancing the invoice after a failed attempt.
|
|
3915
3915
|
*/
|
|
3916
3916
|
export const retryInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3919,11 +3919,11 @@ export const RetryInvoiceActionParams = zod.object({
|
|
|
3919
3919
|
});
|
|
3920
3920
|
/**
|
|
3921
3921
|
* Snapshot quantities for usage based line items.
|
|
3922
|
-
|
|
3923
|
-
This call will snapshot the quantities for all usage based line items in the invoice.
|
|
3924
|
-
|
|
3925
|
-
This call is only valid in `draft.waiting_for_collection` status, where the collection period
|
|
3926
|
-
can be skipped using this action.
|
|
3922
|
+
*
|
|
3923
|
+
* This call will snapshot the quantities for all usage based line items in the invoice.
|
|
3924
|
+
*
|
|
3925
|
+
* This call is only valid in `draft.waiting_for_collection` status, where the collection period
|
|
3926
|
+
* can be skipped using this action.
|
|
3927
3927
|
* @summary Snapshot quantities for usage based line items
|
|
3928
3928
|
*/
|
|
3929
3929
|
export const snapshotQuantitiesInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3934,8 +3934,8 @@ export const SnapshotQuantitiesInvoiceActionParams = zod.object({
|
|
|
3934
3934
|
});
|
|
3935
3935
|
/**
|
|
3936
3936
|
* Recalculate an invoice's tax amounts (using the app set in the customer's billing profile)
|
|
3937
|
-
|
|
3938
|
-
Note: charges might apply, depending on the tax provider.
|
|
3937
|
+
*
|
|
3938
|
+
* Note: charges might apply, depending on the tax provider.
|
|
3939
3939
|
* @summary Recalculate an invoice's tax amounts
|
|
3940
3940
|
*/
|
|
3941
3941
|
export const recalculateInvoiceTaxActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3946,10 +3946,10 @@ export const RecalculateInvoiceTaxActionParams = zod.object({
|
|
|
3946
3946
|
});
|
|
3947
3947
|
/**
|
|
3948
3948
|
* Void an invoice
|
|
3949
|
-
|
|
3950
|
-
Only invoices that have been alread issued can be voided.
|
|
3951
|
-
|
|
3952
|
-
Voiding an invoice will mark it as voided, the user can specify how to handle the voided line items.
|
|
3949
|
+
*
|
|
3950
|
+
* Only invoices that have been alread issued can be voided.
|
|
3951
|
+
*
|
|
3952
|
+
* Voiding an invoice will mark it as voided, the user can specify how to handle the voided line items.
|
|
3953
3953
|
* @summary Void an invoice
|
|
3954
3954
|
*/
|
|
3955
3955
|
export const voidInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -4039,10 +4039,10 @@ export const VoidInvoiceActionBody = zod
|
|
|
4039
4039
|
.describe('Request to void an invoice');
|
|
4040
4040
|
/**
|
|
4041
4041
|
* List all billing profiles matching the specified filters.
|
|
4042
|
-
|
|
4043
|
-
The expand option can be used to include additional information (besides the billing profile)
|
|
4044
|
-
in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
4045
|
-
will be included in the response.
|
|
4042
|
+
*
|
|
4043
|
+
* The expand option can be used to include additional information (besides the billing profile)
|
|
4044
|
+
* in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
4045
|
+
* will be included in the response.
|
|
4046
4046
|
* @summary List billing profiles
|
|
4047
4047
|
*/
|
|
4048
4048
|
export const listBillingProfilesQueryIncludeArchivedDefault = false;
|
|
@@ -4082,9 +4082,9 @@ export const ListBillingProfilesQueryParams = zod.object({
|
|
|
4082
4082
|
});
|
|
4083
4083
|
/**
|
|
4084
4084
|
* Create a new billing profile
|
|
4085
|
-
|
|
4086
|
-
Billing profiles are representations of a customer's billing information. Customer overrides
|
|
4087
|
-
can be applied to a billing profile to customize the billing behavior for a specific customer.
|
|
4085
|
+
*
|
|
4086
|
+
* Billing profiles are representations of a customer's billing information. Customer overrides
|
|
4087
|
+
* can be applied to a billing profile to customize the billing behavior for a specific customer.
|
|
4088
4088
|
* @summary Create a new billing profile
|
|
4089
4089
|
*/
|
|
4090
4090
|
export const createBillingProfileBodyNameMax = 256;
|
|
@@ -4354,11 +4354,11 @@ export const CreateBillingProfileBody = zod
|
|
|
4354
4354
|
.describe('BillingProfileCreate represents the input for creating a billing profile');
|
|
4355
4355
|
/**
|
|
4356
4356
|
* Delete a billing profile by id.
|
|
4357
|
-
|
|
4358
|
-
Only such billing profiles can be deleted that are:
|
|
4359
|
-
- not the default one
|
|
4360
|
-
- not pinned to any customer using customer overrides
|
|
4361
|
-
- only have finalized invoices
|
|
4357
|
+
*
|
|
4358
|
+
* Only such billing profiles can be deleted that are:
|
|
4359
|
+
* - not the default one
|
|
4360
|
+
* - not pinned to any customer using customer overrides
|
|
4361
|
+
* - only have finalized invoices
|
|
4362
4362
|
* @summary Delete a billing profile
|
|
4363
4363
|
*/
|
|
4364
4364
|
export const deleteBillingProfilePathIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -4367,10 +4367,10 @@ export const DeleteBillingProfileParams = zod.object({
|
|
|
4367
4367
|
});
|
|
4368
4368
|
/**
|
|
4369
4369
|
* Get a billing profile by id.
|
|
4370
|
-
|
|
4371
|
-
The expand option can be used to include additional information (besides the billing profile)
|
|
4372
|
-
in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
4373
|
-
will be included in the response.
|
|
4370
|
+
*
|
|
4371
|
+
* The expand option can be used to include additional information (besides the billing profile)
|
|
4372
|
+
* in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
4373
|
+
* will be included in the response.
|
|
4374
4374
|
* @summary Get a billing profile
|
|
4375
4375
|
*/
|
|
4376
4376
|
export const getBillingProfilePathIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -4386,9 +4386,9 @@ export const GetBillingProfileQueryParams = zod.object({
|
|
|
4386
4386
|
});
|
|
4387
4387
|
/**
|
|
4388
4388
|
* Update a billing profile by id.
|
|
4389
|
-
|
|
4390
|
-
The apps field cannot be updated directly, if an app change is desired a new
|
|
4391
|
-
profile should be created.
|
|
4389
|
+
*
|
|
4390
|
+
* The apps field cannot be updated directly, if an app change is desired a new
|
|
4391
|
+
* profile should be created.
|
|
4392
4392
|
* @summary Update a billing profile
|
|
4393
4393
|
*/
|
|
4394
4394
|
export const updateBillingProfilePathIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -5319,7 +5319,7 @@ export const GetCustomerEntitlementValueQueryParams = zod.object({
|
|
|
5319
5319
|
});
|
|
5320
5320
|
/**
|
|
5321
5321
|
* Get stripe app data for a customer.
|
|
5322
|
-
Only returns data if the customer billing profile is linked to a stripe app.
|
|
5322
|
+
* Only returns data if the customer billing profile is linked to a stripe app.
|
|
5323
5323
|
* @summary Get customer stripe app data
|
|
5324
5324
|
*/
|
|
5325
5325
|
export const getCustomerStripeAppDataPathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -5339,7 +5339,7 @@ export const GetCustomerStripeAppDataParams = zod.object({
|
|
|
5339
5339
|
});
|
|
5340
5340
|
/**
|
|
5341
5341
|
* Upsert stripe app data for a customer.
|
|
5342
|
-
Only updates data if the customer billing profile is linked to a stripe app.
|
|
5342
|
+
* Only updates data if the customer billing profile is linked to a stripe app.
|
|
5343
5343
|
* @summary Upsert customer stripe app data
|
|
5344
5344
|
*/
|
|
5345
5345
|
export const upsertCustomerStripeAppDataPathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -5368,10 +5368,10 @@ export const UpsertCustomerStripeAppDataBody = zod
|
|
|
5368
5368
|
.describe('Stripe Customer App Data Base.');
|
|
5369
5369
|
/**
|
|
5370
5370
|
* Create Stripe customer portal session.
|
|
5371
|
-
Only returns URL if the customer billing profile is linked to a stripe app and customer.
|
|
5372
|
-
|
|
5373
|
-
Useful to redirect the customer to the Stripe customer portal to manage their payment methods,
|
|
5374
|
-
change their billing address and access their invoice history.
|
|
5371
|
+
* Only returns URL if the customer billing profile is linked to a stripe app and customer.
|
|
5372
|
+
*
|
|
5373
|
+
* Useful to redirect the customer to the Stripe customer portal to manage their payment methods,
|
|
5374
|
+
* change their billing address and access their invoice history.
|
|
5375
5375
|
* @summary Create Stripe customer portal session
|
|
5376
5376
|
*/
|
|
5377
5377
|
export const createCustomerStripePortalSessionPathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -5457,10 +5457,10 @@ export const ListCustomerSubscriptionsQueryParams = zod.object({
|
|
|
5457
5457
|
});
|
|
5458
5458
|
/**
|
|
5459
5459
|
* List all entitlements for all the subjects and features. This endpoint is intended for administrative purposes only.
|
|
5460
|
-
To fetch the entitlements of a specific subject please use the /api/v1/subjects/{subjectKeyOrID}/entitlements endpoint.
|
|
5461
|
-
If page is provided that takes precedence and the paginated response is returned.
|
|
5462
|
-
|
|
5463
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/entitlements`](#tag/entitlements/get/api/v2/entitlements) instead.
|
|
5460
|
+
* To fetch the entitlements of a specific subject please use the /api/v1/subjects/{subjectKeyOrID}/entitlements endpoint.
|
|
5461
|
+
* If page is provided that takes precedence and the paginated response is returned.
|
|
5462
|
+
*
|
|
5463
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/entitlements`](#tag/entitlements/get/api/v2/entitlements) instead.
|
|
5464
5464
|
* @deprecated
|
|
5465
5465
|
* @summary List all entitlements
|
|
5466
5466
|
*/
|
|
@@ -5526,8 +5526,8 @@ export const ListEntitlementsQueryParams = zod.object({
|
|
|
5526
5526
|
});
|
|
5527
5527
|
/**
|
|
5528
5528
|
* Get entitlement by ID.
|
|
5529
|
-
|
|
5530
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/entitlements/{entitlementId}`](#tag/entitlements/get/api/v2/entitlements/{entitlementId}) instead.
|
|
5529
|
+
*
|
|
5530
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/entitlements/{entitlementId}`](#tag/entitlements/get/api/v2/entitlements/{entitlementId}) instead.
|
|
5531
5531
|
* @deprecated
|
|
5532
5532
|
* @summary Get entitlement by ID
|
|
5533
5533
|
*/
|
|
@@ -5539,8 +5539,8 @@ export const GetEntitlementByIdParams = zod.object({
|
|
|
5539
5539
|
});
|
|
5540
5540
|
/**
|
|
5541
5541
|
* List ingested events within a time range.
|
|
5542
|
-
|
|
5543
|
-
If the from query param is not provided it defaults to last 72 hours.
|
|
5542
|
+
*
|
|
5543
|
+
* If the from query param is not provided it defaults to last 72 hours.
|
|
5544
5544
|
* @summary List ingested events
|
|
5545
5545
|
*/
|
|
5546
5546
|
export const listEventsQueryClientIdMax = 36;
|
|
@@ -5596,90 +5596,46 @@ export const ListEventsQueryParams = zod.object({
|
|
|
5596
5596
|
* Ingests an event or batch of events following the CloudEvents specification.
|
|
5597
5597
|
* @summary Ingest events
|
|
5598
5598
|
*/
|
|
5599
|
-
export const
|
|
5600
|
-
export const ingestEventsBodyTwoItemSpecversionDefault = '1.0';
|
|
5599
|
+
export const ingestEventsBodySpecversionDefault = '1.0';
|
|
5601
5600
|
export const IngestEventsBody = zod
|
|
5602
|
-
.
|
|
5603
|
-
zod
|
|
5604
|
-
.
|
|
5605
|
-
|
|
5606
|
-
|
|
5607
|
-
|
|
5608
|
-
|
|
5609
|
-
|
|
5610
|
-
|
|
5611
|
-
|
|
5612
|
-
|
|
5613
|
-
|
|
5614
|
-
|
|
5615
|
-
|
|
5616
|
-
|
|
5617
|
-
|
|
5618
|
-
|
|
5619
|
-
|
|
5620
|
-
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
|
|
5628
|
-
|
|
5629
|
-
|
|
5630
|
-
|
|
5631
|
-
|
|
5632
|
-
|
|
5633
|
-
|
|
5634
|
-
|
|
5635
|
-
|
|
5636
|
-
|
|
5637
|
-
|
|
5638
|
-
|
|
5639
|
-
|
|
5640
|
-
})
|
|
5641
|
-
.describe('CloudEvents Specification JSON Schema\n\nOptional properties are nullable according to the CloudEvents specification:\nOPTIONAL not omitted attributes MAY be represented as a null JSON value.'),
|
|
5642
|
-
zod.array(zod
|
|
5643
|
-
.object({
|
|
5644
|
-
data: zod
|
|
5645
|
-
.record(zod.string(), zod.unknown())
|
|
5646
|
-
.nullish()
|
|
5647
|
-
.describe('The event payload.\nOptional, if present it must be a JSON object.'),
|
|
5648
|
-
datacontenttype: zod
|
|
5649
|
-
.enum(['application/json'])
|
|
5650
|
-
.nullish()
|
|
5651
|
-
.describe('Content type of the CloudEvents data value. Only the value "application/json" is allowed over HTTP.'),
|
|
5652
|
-
dataschema: zod
|
|
5653
|
-
.url()
|
|
5654
|
-
.min(1)
|
|
5655
|
-
.nullish()
|
|
5656
|
-
.describe('Identifies the schema that data adheres to.'),
|
|
5657
|
-
id: zod.coerce.string().min(1).describe('Identifies the event.'),
|
|
5658
|
-
source: zod.coerce
|
|
5659
|
-
.string()
|
|
5660
|
-
.min(1)
|
|
5661
|
-
.describe('Identifies the context in which an event happened.'),
|
|
5662
|
-
specversion: zod.coerce
|
|
5663
|
-
.string()
|
|
5664
|
-
.min(1)
|
|
5665
|
-
.default(ingestEventsBodyTwoItemSpecversionDefault)
|
|
5666
|
-
.describe('The version of the CloudEvents specification which the event uses.'),
|
|
5667
|
-
subject: zod.coerce
|
|
5668
|
-
.string()
|
|
5669
|
-
.min(1)
|
|
5670
|
-
.describe('Describes the subject of the event in the context of the event producer (identified by source).'),
|
|
5671
|
-
time: zod.coerce
|
|
5672
|
-
.date()
|
|
5673
|
-
.nullish()
|
|
5674
|
-
.describe('Timestamp of when the occurrence happened. Must adhere to RFC 3339.'),
|
|
5675
|
-
type: zod.coerce
|
|
5676
|
-
.string()
|
|
5677
|
-
.min(1)
|
|
5678
|
-
.describe('Contains a value describing the type of event related to the originating occurrence.'),
|
|
5679
|
-
})
|
|
5680
|
-
.describe('CloudEvents Specification JSON Schema\n\nOptional properties are nullable according to the CloudEvents specification:\nOPTIONAL not omitted attributes MAY be represented as a null JSON value.')),
|
|
5681
|
-
])
|
|
5682
|
-
.describe('The body of the events request.\nEither a single event or a batch of events.');
|
|
5601
|
+
.object({
|
|
5602
|
+
data: zod
|
|
5603
|
+
.record(zod.string(), zod.unknown())
|
|
5604
|
+
.nullish()
|
|
5605
|
+
.describe('The event payload.\nOptional, if present it must be a JSON object.'),
|
|
5606
|
+
datacontenttype: zod
|
|
5607
|
+
.enum(['application/json'])
|
|
5608
|
+
.nullish()
|
|
5609
|
+
.describe('Content type of the CloudEvents data value. Only the value "application/json" is allowed over HTTP.'),
|
|
5610
|
+
dataschema: zod
|
|
5611
|
+
.url()
|
|
5612
|
+
.min(1)
|
|
5613
|
+
.nullish()
|
|
5614
|
+
.describe('Identifies the schema that data adheres to.'),
|
|
5615
|
+
id: zod.coerce.string().min(1).describe('Identifies the event.'),
|
|
5616
|
+
source: zod.coerce
|
|
5617
|
+
.string()
|
|
5618
|
+
.min(1)
|
|
5619
|
+
.describe('Identifies the context in which an event happened.'),
|
|
5620
|
+
specversion: zod.coerce
|
|
5621
|
+
.string()
|
|
5622
|
+
.min(1)
|
|
5623
|
+
.default(ingestEventsBodySpecversionDefault)
|
|
5624
|
+
.describe('The version of the CloudEvents specification which the event uses.'),
|
|
5625
|
+
subject: zod.coerce
|
|
5626
|
+
.string()
|
|
5627
|
+
.min(1)
|
|
5628
|
+
.describe('Describes the subject of the event in the context of the event producer (identified by source).'),
|
|
5629
|
+
time: zod.coerce
|
|
5630
|
+
.date()
|
|
5631
|
+
.nullish()
|
|
5632
|
+
.describe('Timestamp of when the occurrence happened. Must adhere to RFC 3339.'),
|
|
5633
|
+
type: zod.coerce
|
|
5634
|
+
.string()
|
|
5635
|
+
.min(1)
|
|
5636
|
+
.describe('Contains a value describing the type of event related to the originating occurrence.'),
|
|
5637
|
+
})
|
|
5638
|
+
.describe('CloudEvents Specification JSON Schema\n\nOptional properties are nullable according to the CloudEvents specification:\nOPTIONAL not omitted attributes MAY be represented as a null JSON value.');
|
|
5683
5639
|
/**
|
|
5684
5640
|
* List features.
|
|
5685
5641
|
* @summary List features
|
|
@@ -5736,8 +5692,8 @@ export const ListFeaturesQueryParams = zod.object({
|
|
|
5736
5692
|
});
|
|
5737
5693
|
/**
|
|
5738
5694
|
* Features are either metered or static. A feature is metered if meterSlug is provided at creation.
|
|
5739
|
-
For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
|
|
5740
|
-
Meters with SUM, COUNT, UNIQUE_COUNT and LATEST aggregations are supported for features.
|
|
5695
|
+
* For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
|
|
5696
|
+
* Meters with SUM, COUNT, UNIQUE_COUNT and LATEST aggregations are supported for features.
|
|
5741
5697
|
* @summary Create feature
|
|
5742
5698
|
*/
|
|
5743
5699
|
export const createFeatureBodyKeyMax = 64;
|
|
@@ -5927,9 +5883,9 @@ export const GetFeatureParams = zod.object({
|
|
|
5927
5883
|
});
|
|
5928
5884
|
/**
|
|
5929
5885
|
* Archive a feature by ID.
|
|
5930
|
-
|
|
5931
|
-
Once a feature is archived it cannot be unarchived. If a feature is archived, new entitlements cannot be created for it, but archiving the feature does not affect existing entitlements.
|
|
5932
|
-
This means, if you want to create a new feature with the same key, and then create entitlements for it, the previous entitlements have to be deleted first on a per subject basis.
|
|
5886
|
+
*
|
|
5887
|
+
* Once a feature is archived it cannot be unarchived. If a feature is archived, new entitlements cannot be created for it, but archiving the feature does not affect existing entitlements.
|
|
5888
|
+
* This means, if you want to create a new feature with the same key, and then create entitlements for it, the previous entitlements have to be deleted first on a per subject basis.
|
|
5933
5889
|
* @summary Delete feature
|
|
5934
5890
|
*/
|
|
5935
5891
|
export const DeleteFeatureParams = zod.object({
|
|
@@ -5937,10 +5893,10 @@ export const DeleteFeatureParams = zod.object({
|
|
|
5937
5893
|
});
|
|
5938
5894
|
/**
|
|
5939
5895
|
* List all grants for all the subjects and entitlements. This endpoint is intended for administrative purposes only.
|
|
5940
|
-
To fetch the grants of a specific entitlement please use the /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint.
|
|
5941
|
-
If page is provided that takes precedence and the paginated response is returned.
|
|
5942
|
-
|
|
5943
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/grants`](#tag/entitlements/get/api/v2/grants) instead.
|
|
5896
|
+
* To fetch the grants of a specific entitlement please use the /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint.
|
|
5897
|
+
* If page is provided that takes precedence and the paginated response is returned.
|
|
5898
|
+
*
|
|
5899
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/grants`](#tag/entitlements/get/api/v2/grants) instead.
|
|
5944
5900
|
* @deprecated
|
|
5945
5901
|
* @summary List grants
|
|
5946
5902
|
*/
|
|
@@ -6000,7 +5956,7 @@ export const ListGrantsQueryParams = zod.object({
|
|
|
6000
5956
|
});
|
|
6001
5957
|
/**
|
|
6002
5958
|
* Voiding a grant means it is no longer valid, it doesn't take part in further balance calculations. Voiding a grant does not retroactively take effect, meaning any usage that has already been attributed to the grant will remain, but future usage cannot be burnt down from the grant.
|
|
6003
|
-
For example, if you have a single grant for your metered entitlement with an initial amount of 100, and so far 60 usage has been metered, the grant (and the entitlement itself) would have a balance of 40. If you then void that grant, balance becomes 0, but the 60 previous usage will not be affected.
|
|
5959
|
+
* For example, if you have a single grant for your metered entitlement with an initial amount of 100, and so far 60 usage has been metered, the grant (and the entitlement itself) would have a balance of 40. If you then void that grant, balance becomes 0, but the 60 previous usage will not be affected.
|
|
6004
5960
|
* @summary Void grant
|
|
6005
5961
|
*/
|
|
6006
5962
|
export const VoidGrantParams = zod.object({
|
|
@@ -6093,7 +6049,7 @@ export const MarketplaceAppAPIKeyInstallBody = zod.object({
|
|
|
6093
6049
|
});
|
|
6094
6050
|
/**
|
|
6095
6051
|
* Install an app via OAuth.
|
|
6096
|
-
Returns a URL to start the OAuth 2.0 flow.
|
|
6052
|
+
* Returns a URL to start the OAuth 2.0 flow.
|
|
6097
6053
|
* @summary Get OAuth2 install URL
|
|
6098
6054
|
*/
|
|
6099
6055
|
export const MarketplaceOAuth2InstallGetURLParams = zod.object({
|
|
@@ -6101,7 +6057,7 @@ export const MarketplaceOAuth2InstallGetURLParams = zod.object({
|
|
|
6101
6057
|
});
|
|
6102
6058
|
/**
|
|
6103
6059
|
* Authorize OAuth2 code.
|
|
6104
|
-
Verifies the OAuth code and exchanges it for a token and refresh token
|
|
6060
|
+
* Verifies the OAuth code and exchanges it for a token and refresh token
|
|
6105
6061
|
* @summary Install app via OAuth2
|
|
6106
6062
|
*/
|
|
6107
6063
|
export const MarketplaceOAuth2InstallAuthorizeParams = zod.object({
|
|
@@ -6660,8 +6616,8 @@ export const GetNotificationChannelParams = zod.object({
|
|
|
6660
6616
|
});
|
|
6661
6617
|
/**
|
|
6662
6618
|
* Soft delete notification channel by id.
|
|
6663
|
-
|
|
6664
|
-
Once a notification channel is deleted it cannot be undeleted.
|
|
6619
|
+
*
|
|
6620
|
+
* Once a notification channel is deleted it cannot be undeleted.
|
|
6665
6621
|
* @summary Delete a notification channel
|
|
6666
6622
|
*/
|
|
6667
6623
|
export const deleteNotificationChannelPathChannelIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -7171,8 +7127,8 @@ export const GetNotificationRuleParams = zod.object({
|
|
|
7171
7127
|
});
|
|
7172
7128
|
/**
|
|
7173
7129
|
* Soft delete notification rule by id.
|
|
7174
|
-
|
|
7175
|
-
Once a notification rule is deleted it cannot be undeleted.
|
|
7130
|
+
*
|
|
7131
|
+
* Once a notification rule is deleted it cannot be undeleted.
|
|
7176
7132
|
* @summary Delete a notification rule
|
|
7177
7133
|
*/
|
|
7178
7134
|
export const deleteNotificationRulePathRuleIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -7949,7 +7905,7 @@ export const CreatePlanBody = zod
|
|
|
7949
7905
|
.describe('Resource create operation model.');
|
|
7950
7906
|
/**
|
|
7951
7907
|
* Create a new draft version from plan.
|
|
7952
|
-
It returns error if there is already a plan in draft or planId does not reference the latest published version.
|
|
7908
|
+
* It returns error if there is already a plan in draft or planId does not reference the latest published version.
|
|
7953
7909
|
* @deprecated
|
|
7954
7910
|
* @summary New draft plan
|
|
7955
7911
|
*/
|
|
@@ -8652,8 +8608,8 @@ export const GetPlanQueryParams = zod.object({
|
|
|
8652
8608
|
});
|
|
8653
8609
|
/**
|
|
8654
8610
|
* Soft delete plan by plan.id.
|
|
8655
|
-
|
|
8656
|
-
Once a plan is deleted it cannot be undeleted.
|
|
8611
|
+
*
|
|
8612
|
+
* Once a plan is deleted it cannot be undeleted.
|
|
8657
8613
|
* @summary Delete plan
|
|
8658
8614
|
*/
|
|
8659
8615
|
export const deletePlanPathPlanIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -8804,8 +8760,8 @@ export const GetPlanAddonParams = zod.object({
|
|
|
8804
8760
|
});
|
|
8805
8761
|
/**
|
|
8806
8762
|
* Delete add-on assignment for plan.
|
|
8807
|
-
|
|
8808
|
-
Once a plan is deleted it cannot be undeleted.
|
|
8763
|
+
*
|
|
8764
|
+
* Once a plan is deleted it cannot be undeleted.
|
|
8809
8765
|
* @summary Delete add-on assignment for plan
|
|
8810
8766
|
*/
|
|
8811
8767
|
export const deletePlanAddonPathPlanIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -9223,11 +9179,11 @@ export const CreateStripeCheckoutSessionBody = zod
|
|
|
9223
9179
|
.describe('Create Stripe checkout session request.');
|
|
9224
9180
|
/**
|
|
9225
9181
|
* Upserts a subject. Creates or updates subject.
|
|
9226
|
-
|
|
9227
|
-
If the subject doesn't exist, it will be created.
|
|
9228
|
-
If the subject exists, it will be partially updated with the provided fields.
|
|
9229
|
-
|
|
9230
|
-
⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9182
|
+
*
|
|
9183
|
+
* If the subject doesn't exist, it will be created.
|
|
9184
|
+
* If the subject exists, it will be partially updated with the provided fields.
|
|
9185
|
+
*
|
|
9186
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9231
9187
|
* @deprecated
|
|
9232
9188
|
* @summary Upsert subject
|
|
9233
9189
|
*/
|
|
@@ -9261,8 +9217,8 @@ export const UpsertSubjectBodyItem = zod
|
|
|
9261
9217
|
export const UpsertSubjectBody = zod.array(UpsertSubjectBodyItem);
|
|
9262
9218
|
/**
|
|
9263
9219
|
* Get subject by ID or key.
|
|
9264
|
-
|
|
9265
|
-
⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9220
|
+
*
|
|
9221
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9266
9222
|
* @deprecated
|
|
9267
9223
|
* @summary Get subject
|
|
9268
9224
|
*/
|
|
@@ -9271,8 +9227,8 @@ export const GetSubjectParams = zod.object({
|
|
|
9271
9227
|
});
|
|
9272
9228
|
/**
|
|
9273
9229
|
* Delete subject by ID or key.
|
|
9274
|
-
|
|
9275
|
-
⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9230
|
+
*
|
|
9231
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9276
9232
|
* @deprecated
|
|
9277
9233
|
* @summary Delete subject
|
|
9278
9234
|
*/
|
|
@@ -9281,16 +9237,16 @@ export const DeleteSubjectParams = zod.object({
|
|
|
9281
9237
|
});
|
|
9282
9238
|
/**
|
|
9283
9239
|
* OpenMeter has three types of entitlements: metered, boolean, and static. The type property determines the type of entitlement. The underlying feature has to be compatible with the entitlement type specified in the request (e.g., a metered entitlement needs a feature associated with a meter).
|
|
9284
|
-
|
|
9285
|
-
- Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
9286
|
-
- Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
9287
|
-
- Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems. Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
|
|
9288
|
-
|
|
9289
|
-
A given subject can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
|
|
9290
|
-
|
|
9291
|
-
Once an entitlement is created you cannot modify it, only delete it.
|
|
9292
|
-
|
|
9293
|
-
⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
9240
|
+
*
|
|
9241
|
+
* - Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
9242
|
+
* - Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
9243
|
+
* - Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems. Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
|
|
9244
|
+
*
|
|
9245
|
+
* A given subject can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
|
|
9246
|
+
*
|
|
9247
|
+
* Once an entitlement is created you cannot modify it, only delete it.
|
|
9248
|
+
*
|
|
9249
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
9294
9250
|
* @deprecated
|
|
9295
9251
|
* @summary Create a subject entitlement
|
|
9296
9252
|
*/
|
|
@@ -9487,8 +9443,8 @@ export const CreateEntitlementBody = zod
|
|
|
9487
9443
|
.describe('Create inputs for entitlement');
|
|
9488
9444
|
/**
|
|
9489
9445
|
* List all entitlements for a subject. For checking entitlement access, use the /value endpoint instead.
|
|
9490
|
-
|
|
9491
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
9446
|
+
*
|
|
9447
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
9492
9448
|
* @deprecated
|
|
9493
9449
|
* @summary List subject entitlements
|
|
9494
9450
|
*/
|
|
@@ -9503,8 +9459,8 @@ export const ListSubjectEntitlementsQueryParams = zod.object({
|
|
|
9503
9459
|
});
|
|
9504
9460
|
/**
|
|
9505
9461
|
* List all grants issued for an entitlement. The entitlement can be defined either by its id or featureKey.
|
|
9506
|
-
|
|
9507
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
9462
|
+
*
|
|
9463
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
9508
9464
|
* @deprecated
|
|
9509
9465
|
* @summary List subject entitlement grants
|
|
9510
9466
|
*/
|
|
@@ -9525,18 +9481,18 @@ export const ListEntitlementGrantsQueryParams = zod.object({
|
|
|
9525
9481
|
});
|
|
9526
9482
|
/**
|
|
9527
9483
|
* Grants define a behavior of granting usage for a metered entitlement. They can have complicated recurrence and rollover rules, thanks to which you can define a wide range of access patterns with a single grant, in most cases you don't have to periodically create new grants. You can only issue grants for active metered entitlements.
|
|
9528
|
-
|
|
9529
|
-
A grant defines a given amount of usage that can be consumed for the entitlement. The grant is in effect between its effective date and its expiration date. Specifying both is mandatory for new grants.
|
|
9530
|
-
|
|
9531
|
-
Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
9532
|
-
|
|
9533
|
-
Grants can have a recurrence setting intended to automate the manual reissuing of grants. For example, a daily recurrence is equal to reissuing that same grant every day (ignoring rollover settings).
|
|
9534
|
-
|
|
9535
|
-
Rollover settings define what happens to the remaining balance of a grant at a reset. Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
|
|
9536
|
-
|
|
9537
|
-
Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
9538
|
-
|
|
9539
|
-
⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
9484
|
+
*
|
|
9485
|
+
* A grant defines a given amount of usage that can be consumed for the entitlement. The grant is in effect between its effective date and its expiration date. Specifying both is mandatory for new grants.
|
|
9486
|
+
*
|
|
9487
|
+
* Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
9488
|
+
*
|
|
9489
|
+
* Grants can have a recurrence setting intended to automate the manual reissuing of grants. For example, a daily recurrence is equal to reissuing that same grant every day (ignoring rollover settings).
|
|
9490
|
+
*
|
|
9491
|
+
* Rollover settings define what happens to the remaining balance of a grant at a reset. Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
|
|
9492
|
+
*
|
|
9493
|
+
* Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
9494
|
+
*
|
|
9495
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
9540
9496
|
* @deprecated
|
|
9541
9497
|
* @summary Create subject entitlement grant
|
|
9542
9498
|
*/
|
|
@@ -9617,10 +9573,10 @@ export const CreateGrantBody = zod
|
|
|
9617
9573
|
.describe('The grant creation input.');
|
|
9618
9574
|
/**
|
|
9619
9575
|
* Overriding an entitlement creates a new entitlement from the provided inputs and soft deletes the previous entitlement for the provided subject-feature pair. If the previous entitlement is already deleted or otherwise doesnt exist, the override will fail.
|
|
9620
|
-
|
|
9621
|
-
This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
9622
|
-
|
|
9623
|
-
⚠️ __Deprecated__: Use [`PUT /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override`](#tag/entitlements/put/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override) instead.
|
|
9576
|
+
*
|
|
9577
|
+
* This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
9578
|
+
*
|
|
9579
|
+
* ⚠️ __Deprecated__: Use [`PUT /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override`](#tag/entitlements/put/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override) instead.
|
|
9624
9580
|
* @deprecated
|
|
9625
9581
|
* @summary Override subject entitlement
|
|
9626
9582
|
*/
|
|
@@ -9818,10 +9774,10 @@ export const OverrideEntitlementBody = zod
|
|
|
9818
9774
|
.describe('Create inputs for entitlement');
|
|
9819
9775
|
/**
|
|
9820
9776
|
* This endpoint should be used for access checks and enforcement. All entitlement types share the hasAccess property in their value response, but multiple other properties are returned based on the entitlement type.
|
|
9821
|
-
|
|
9822
|
-
For convenience reasons, /value works with both entitlementId and featureKey.
|
|
9823
|
-
|
|
9824
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value) instead.
|
|
9777
|
+
*
|
|
9778
|
+
* For convenience reasons, /value works with both entitlementId and featureKey.
|
|
9779
|
+
*
|
|
9780
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value) instead.
|
|
9825
9781
|
* @deprecated
|
|
9826
9782
|
* @summary Get subject entitlement value
|
|
9827
9783
|
*/
|
|
@@ -9834,8 +9790,8 @@ export const GetEntitlementValueQueryParams = zod.object({
|
|
|
9834
9790
|
});
|
|
9835
9791
|
/**
|
|
9836
9792
|
* Get entitlement by id. For checking entitlement access, use the /value endpoint instead.
|
|
9837
|
-
|
|
9838
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
9793
|
+
*
|
|
9794
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
9839
9795
|
* @deprecated
|
|
9840
9796
|
* @summary Get subject entitlement
|
|
9841
9797
|
*/
|
|
@@ -9845,9 +9801,9 @@ export const GetEntitlementParams = zod.object({
|
|
|
9845
9801
|
});
|
|
9846
9802
|
/**
|
|
9847
9803
|
* Deleting an entitlement revokes access to the associated feature. As a single subject can only have one entitlement per featureKey, when "migrating" features you have to delete the old entitlements as well.
|
|
9848
|
-
As access and status checks can be historical queries, deleting an entitlement populates the deletedAt timestamp. When queried for a time before that, the entitlement is still considered active, you cannot have retroactive changes to access, which is important for, among other things, auditing.
|
|
9849
|
-
|
|
9850
|
-
⚠️ __Deprecated__: Use [`DELETE /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/delete/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
9804
|
+
* As access and status checks can be historical queries, deleting an entitlement populates the deletedAt timestamp. When queried for a time before that, the entitlement is still considered active, you cannot have retroactive changes to access, which is important for, among other things, auditing.
|
|
9805
|
+
*
|
|
9806
|
+
* ⚠️ __Deprecated__: Use [`DELETE /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/delete/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
9851
9807
|
* @deprecated
|
|
9852
9808
|
* @summary Delete subject entitlement
|
|
9853
9809
|
*/
|
|
@@ -9857,12 +9813,12 @@ export const DeleteEntitlementParams = zod.object({
|
|
|
9857
9813
|
});
|
|
9858
9814
|
/**
|
|
9859
9815
|
* Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
|
|
9860
|
-
|
|
9861
|
-
BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
|
|
9862
|
-
|
|
9863
|
-
WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
|
|
9864
|
-
|
|
9865
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history) instead.
|
|
9816
|
+
*
|
|
9817
|
+
* BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
|
|
9818
|
+
*
|
|
9819
|
+
* WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
|
|
9820
|
+
*
|
|
9821
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history) instead.
|
|
9866
9822
|
* @deprecated
|
|
9867
9823
|
* @summary Get subject entitlement history
|
|
9868
9824
|
*/
|
|
@@ -9890,10 +9846,10 @@ export const GetEntitlementHistoryQueryParams = zod.object({
|
|
|
9890
9846
|
});
|
|
9891
9847
|
/**
|
|
9892
9848
|
* Reset marks the start of a new usage period for the entitlement and initiates grant rollover. At the start of a period usage is zerod out and grants are rolled over based on their rollover settings. It would typically be synced with the subjects billing period to enforce usage based on their subscription.
|
|
9893
|
-
|
|
9894
|
-
Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
|
|
9895
|
-
|
|
9896
|
-
⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset) instead.
|
|
9849
|
+
*
|
|
9850
|
+
* Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
|
|
9851
|
+
*
|
|
9852
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset) instead.
|
|
9897
9853
|
* @deprecated
|
|
9898
9854
|
* @summary Reset subject entitlement
|
|
9899
9855
|
*/
|
|
@@ -10733,7 +10689,7 @@ export const GetSubscriptionQueryParams = zod.object({
|
|
|
10733
10689
|
});
|
|
10734
10690
|
/**
|
|
10735
10691
|
* Batch processing commands for manipulating running subscriptions.
|
|
10736
|
-
The key format is `/phases/{phaseKey}` or `/phases/{phaseKey}/items/{itemKey}`.
|
|
10692
|
+
* The key format is `/phases/{phaseKey}` or `/phases/{phaseKey}/items/{itemKey}`.
|
|
10737
10693
|
* @summary Edit subscription
|
|
10738
10694
|
*/
|
|
10739
10695
|
export const editSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -11567,7 +11523,7 @@ export const UpdateSubscriptionAddonBody = zod
|
|
|
11567
11523
|
.describe('Resource create or update operation model.');
|
|
11568
11524
|
/**
|
|
11569
11525
|
* Cancels the subscription.
|
|
11570
|
-
Will result in a scheduling conflict if there are other subscriptions scheduled to start after the cancellation time.
|
|
11526
|
+
* Will result in a scheduling conflict if there are other subscriptions scheduled to start after the cancellation time.
|
|
11571
11527
|
* @summary Cancel subscription
|
|
11572
11528
|
*/
|
|
11573
11529
|
export const cancelSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -11592,7 +11548,7 @@ export const CancelSubscriptionBody = zod.object({
|
|
|
11592
11548
|
});
|
|
11593
11549
|
/**
|
|
11594
11550
|
* Closes a running subscription and starts a new one according to the specification.
|
|
11595
|
-
Can be used for upgrades, downgrades, and plan changes.
|
|
11551
|
+
* Can be used for upgrades, downgrades, and plan changes.
|
|
11596
11552
|
* @summary Change subscription
|
|
11597
11553
|
*/
|
|
11598
11554
|
export const changeSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12369,8 +12325,8 @@ export const ChangeSubscriptionBody = zod
|
|
|
12369
12325
|
.describe('Change a subscription.');
|
|
12370
12326
|
/**
|
|
12371
12327
|
* Migrates the subscripiton to the provided version of the current plan.
|
|
12372
|
-
If possible, the migration will be done immediately.
|
|
12373
|
-
If not, the migration will be scheduled to the end of the current billing period.
|
|
12328
|
+
* If possible, the migration will be done immediately.
|
|
12329
|
+
* If not, the migration will be scheduled to the end of the current billing period.
|
|
12374
12330
|
* @summary Migrate subscription
|
|
12375
12331
|
*/
|
|
12376
12332
|
export const migrateSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12410,7 +12366,7 @@ export const MigrateSubscriptionBody = zod.object({
|
|
|
12410
12366
|
});
|
|
12411
12367
|
/**
|
|
12412
12368
|
* Restores a canceled subscription.
|
|
12413
|
-
Any subscription scheduled to start later will be deleted and this subscription will be continued indefinitely.
|
|
12369
|
+
* Any subscription scheduled to start later will be deleted and this subscription will be continued indefinitely.
|
|
12414
12370
|
* @deprecated
|
|
12415
12371
|
* @summary Restore subscription
|
|
12416
12372
|
*/
|
|
@@ -12432,14 +12388,14 @@ export const UnscheduleCancelationParams = zod.object({
|
|
|
12432
12388
|
});
|
|
12433
12389
|
/**
|
|
12434
12390
|
* OpenMeter has three types of entitlements: metered, boolean, and static. The type property determines the type of entitlement. The underlying feature has to be compatible with the entitlement type specified in the request (e.g., a metered entitlement needs a feature associated with a meter).
|
|
12435
|
-
|
|
12436
|
-
- Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
12437
|
-
- Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
12438
|
-
- Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems. Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
|
|
12439
|
-
|
|
12440
|
-
A given customer can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
|
|
12441
|
-
|
|
12442
|
-
Once an entitlement is created you cannot modify it, only delete it.
|
|
12391
|
+
*
|
|
12392
|
+
* - Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
12393
|
+
* - Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
12394
|
+
* - Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems. Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
|
|
12395
|
+
*
|
|
12396
|
+
* A given customer can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
|
|
12397
|
+
*
|
|
12398
|
+
* Once an entitlement is created you cannot modify it, only delete it.
|
|
12443
12399
|
* @summary Create a customer entitlement
|
|
12444
12400
|
*/
|
|
12445
12401
|
export const createCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12789,7 +12745,7 @@ export const ListCustomerEntitlementsV2QueryParams = zod.object({
|
|
|
12789
12745
|
});
|
|
12790
12746
|
/**
|
|
12791
12747
|
* Get entitlement by feature key. For checking entitlement access, use the /value endpoint instead.
|
|
12792
|
-
If featureKey is used, the entitlement is resolved for the current timestamp.
|
|
12748
|
+
* If featureKey is used, the entitlement is resolved for the current timestamp.
|
|
12793
12749
|
* @summary Get customer entitlement
|
|
12794
12750
|
*/
|
|
12795
12751
|
export const getCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12816,7 +12772,7 @@ export const GetCustomerEntitlementV2Params = zod.object({
|
|
|
12816
12772
|
});
|
|
12817
12773
|
/**
|
|
12818
12774
|
* Deleting an entitlement revokes access to the associated feature. As a single customer can only have one entitlement per featureKey, when "migrating" features you have to delete the old entitlements as well.
|
|
12819
|
-
As access and status checks can be historical queries, deleting an entitlement populates the deletedAt timestamp. When queried for a time before that, the entitlement is still considered active, you cannot have retroactive changes to access, which is important for, among other things, auditing.
|
|
12775
|
+
* As access and status checks can be historical queries, deleting an entitlement populates the deletedAt timestamp. When queried for a time before that, the entitlement is still considered active, you cannot have retroactive changes to access, which is important for, among other things, auditing.
|
|
12820
12776
|
* @summary Delete customer entitlement
|
|
12821
12777
|
*/
|
|
12822
12778
|
export const deleteCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12914,16 +12870,16 @@ export const ListCustomerEntitlementGrantsV2QueryParams = zod.object({
|
|
|
12914
12870
|
});
|
|
12915
12871
|
/**
|
|
12916
12872
|
* Grants define a behavior of granting usage for a metered entitlement. They can have complicated recurrence and rollover rules, thanks to which you can define a wide range of access patterns with a single grant, in most cases you don't have to periodically create new grants. You can only issue grants for active metered entitlements.
|
|
12917
|
-
|
|
12918
|
-
A grant defines a given amount of usage that can be consumed for the entitlement. The grant is in effect between its effective date and its expiration date. Specifying both is mandatory for new grants.
|
|
12919
|
-
|
|
12920
|
-
Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
12921
|
-
|
|
12922
|
-
Grants can have a recurrence setting intended to automate the manual reissuing of grants. For example, a daily recurrence is equal to reissuing that same grant every day (ignoring rollover settings).
|
|
12923
|
-
|
|
12924
|
-
Rollover settings define what happens to the remaining balance of a grant at a reset. Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
|
|
12925
|
-
|
|
12926
|
-
Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
12873
|
+
*
|
|
12874
|
+
* A grant defines a given amount of usage that can be consumed for the entitlement. The grant is in effect between its effective date and its expiration date. Specifying both is mandatory for new grants.
|
|
12875
|
+
*
|
|
12876
|
+
* Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
12877
|
+
*
|
|
12878
|
+
* Grants can have a recurrence setting intended to automate the manual reissuing of grants. For example, a daily recurrence is equal to reissuing that same grant every day (ignoring rollover settings).
|
|
12879
|
+
*
|
|
12880
|
+
* Rollover settings define what happens to the remaining balance of a grant at a reset. Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
|
|
12881
|
+
*
|
|
12882
|
+
* Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
12927
12883
|
* @summary Create customer entitlement grant
|
|
12928
12884
|
*/
|
|
12929
12885
|
export const createCustomerEntitlementGrantV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -13026,10 +12982,10 @@ export const CreateCustomerEntitlementGrantV2Body = zod
|
|
|
13026
12982
|
.describe('The grant creation input.');
|
|
13027
12983
|
/**
|
|
13028
12984
|
* Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
|
|
13029
|
-
|
|
13030
|
-
BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
|
|
13031
|
-
|
|
13032
|
-
WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
|
|
12985
|
+
*
|
|
12986
|
+
* BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
|
|
12987
|
+
*
|
|
12988
|
+
* WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
|
|
13033
12989
|
* @summary Get customer entitlement history
|
|
13034
12990
|
*/
|
|
13035
12991
|
export const getCustomerEntitlementHistoryV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -13074,8 +13030,8 @@ export const GetCustomerEntitlementHistoryV2QueryParams = zod.object({
|
|
|
13074
13030
|
});
|
|
13075
13031
|
/**
|
|
13076
13032
|
* Overriding an entitlement creates a new entitlement from the provided inputs and soft deletes the previous entitlement for the provided customer-feature pair. If the previous entitlement is already deleted or otherwise doesnt exist, the override will fail.
|
|
13077
|
-
|
|
13078
|
-
This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
13033
|
+
*
|
|
13034
|
+
* This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
13079
13035
|
* @summary Override customer entitlement
|
|
13080
13036
|
*/
|
|
13081
13037
|
export const overrideCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -13389,8 +13345,8 @@ export const OverrideCustomerEntitlementV2Body = zod
|
|
|
13389
13345
|
.describe('Create inputs for entitlement');
|
|
13390
13346
|
/**
|
|
13391
13347
|
* Reset marks the start of a new usage period for the entitlement and initiates grant rollover. At the start of a period usage is zerod out and grants are rolled over based on their rollover settings. It would typically be synced with the customers billing period to enforce usage based on their subscription.
|
|
13392
|
-
|
|
13393
|
-
Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
|
|
13348
|
+
*
|
|
13349
|
+
* Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
|
|
13394
13350
|
* @summary Reset customer entitlement
|
|
13395
13351
|
*/
|
|
13396
13352
|
export const resetCustomerEntitlementUsageV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -13462,7 +13418,7 @@ export const GetCustomerEntitlementValueV2QueryParams = zod.object({
|
|
|
13462
13418
|
});
|
|
13463
13419
|
/**
|
|
13464
13420
|
* List all entitlements for all the customers and features. This endpoint is intended for administrative purposes only.
|
|
13465
|
-
To fetch the entitlements of a specific subject please use the /api/v2/customers/{customerIdOrKey}/entitlements endpoint.
|
|
13421
|
+
* To fetch the entitlements of a specific subject please use the /api/v2/customers/{customerIdOrKey}/entitlements endpoint.
|
|
13466
13422
|
* @summary List all entitlements
|
|
13467
13423
|
*/
|
|
13468
13424
|
export const listEntitlementsV2QueryExcludeInactiveDefault = false;
|
|
@@ -13566,8 +13522,8 @@ export const ListEventsV2QueryParams = zod.object({
|
|
|
13566
13522
|
});
|
|
13567
13523
|
/**
|
|
13568
13524
|
* List all grants for all the customers and entitlements. This endpoint is intended for administrative purposes only.
|
|
13569
|
-
To fetch the grants of a specific entitlement please use the /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants endpoint.
|
|
13570
|
-
If page is provided that takes precedence and the paginated response is returned.
|
|
13525
|
+
* To fetch the grants of a specific entitlement please use the /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants endpoint.
|
|
13526
|
+
* If page is provided that takes precedence and the paginated response is returned.
|
|
13571
13527
|
* @summary List grants
|
|
13572
13528
|
*/
|
|
13573
13529
|
export const listGrantsV2QueryCustomerItemOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|