@openmeter/sdk 1.0.0-beta-7cf71f2fbc46 → 1.0.0-beta-01a09ff04a38

package/dist/cjs/src/client/customers.d.cts

@@ -543,7 +543,7 @@ export declare class CustomerEntitlementsV2 {
         totalCount: number;
         page: number;
         pageSize: number;
-        items: import("./schemas.cjs").components["schemas"]["EntitlementGrant"][];
+        items: import("./schemas.cjs").components["schemas"]["EntitlementGrantV2"][];
     }>;
     /**
      * Create a grant for a customer entitlement
@@ -560,10 +560,11 @@ export declare class CustomerEntitlementsV2 {
         amount: number;
         priority?: number;
         effectiveAt: Date;
-        expiration: import("./schemas.cjs").components["schemas"]["ExpirationPeriod"];
-        maxRolloverAmount?: number;
         minRolloverAmount?: number;
+        maxRolloverAmount?: number;
+        expiration?: import("./schemas.cjs").components["schemas"]["ExpirationPeriod"];
         metadata?: import("./schemas.cjs").components["schemas"]["Metadata"];
+        annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
         readonly id: string;
         readonly entitlementId: string;
         nextRecurrence?: Date;

package/dist/cjs/src/client/entitlements.d.cts

@@ -651,7 +651,7 @@ export declare class GrantsV2 {
         totalCount: number;
         page: number;
         pageSize: number;
-        items: import("./schemas.cjs").components["schemas"]["EntitlementGrant"][];
+        items: import("./schemas.cjs").components["schemas"]["EntitlementGrantV2"][];
     }>;
     /**
      * Void a grant (legacy method using V1 endpoint)

package/dist/cjs/src/client/schemas.d.cts

@@ -4695,6 +4695,175 @@ export interface components {
             /** @description The subject of the grant. */
             recurrence?: components['schemas']['RecurringPeriodCreateInput'];
         };
+        /** @description The grant creation input. */
+        EntitlementGrantCreateInputV2: {
+            /**
+             * Format: double
+             * @description The amount to grant. Should be a positive number.
+             * @example 100
+             */
+            amount: number;
+            /**
+             * Format: uint8
+             * @description The priority of the grant. Grants with higher priority are applied first.
+             *     Priority is a positive decimal numbers. With lower numbers indicating higher importance.
+             *     For example, a priority of 1 is more urgent than a priority of 2.
+             *     When there are several grants available for the same subject, the system selects the grant with the highest priority.
+             *     In cases where grants share the same priority level, the grant closest to its expiration will be used first.
+             *     In the case of two grants have identical priorities and expiration dates, the system will use the grant that was created first.
+             * @example 1
+             */
+            priority?: number;
+            /**
+             * Format: date-time
+             * @description Effective date for grants and anchor for recurring grants. Provided value will be ceiled to metering windowSize (minute).
+             * @example 2023-01-01T01:01:01.001Z
+             */
+            effectiveAt: Date;
+            /**
+             * Format: double
+             * @description Grants are rolled over at reset, after which they can have a different balance compared to what they had before the reset.
+             *     Balance after the reset is calculated as: Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
+             * @default 0
+             * @example 100
+             */
+            minRolloverAmount?: number;
+            /** @description The subject of the grant. */
+            recurrence?: components['schemas']['RecurringPeriodCreateInput'];
+            /**
+             * Format: double
+             * @description Grants are rolled over at reset, after which they can have a different balance compared to what they had before the reset. The default value equals grant amount.
+             *     Balance after the reset is calculated as: Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
+             * @example 100
+             */
+            maxRolloverAmount?: number;
+            /** @description The grant expiration definition. If no expiration is provided, the grant can be active indefinitely. */
+            expiration?: components['schemas']['ExpirationPeriod'];
+            /**
+             * @deprecated
+             * @description The grant metadata.
+             * @example {
+             *       "stripePaymentId": "pi_4OrAkhLvyihio9p51h9iiFnB"
+             *     }
+             */
+            metadata?: components['schemas']['Metadata'];
+            /**
+             * @description The grant metadata.
+             * @example {
+             *       "stripePaymentId": "pi_4OrAkhLvyihio9p51h9iiFnB"
+             *     }
+             */
+            annotations?: components['schemas']['Annotations'];
+        };
+        /** @description The grant. */
+        EntitlementGrantV2: {
+            /**
+             * Creation Time
+             * Format: date-time
+             * @description Timestamp of when the resource was created.
+             * @example 2024-01-01T01:01:01.001Z
+             */
+            readonly createdAt: Date;
+            /**
+             * Last Update Time
+             * Format: date-time
+             * @description Timestamp of when the resource was last updated.
+             * @example 2024-01-01T01:01:01.001Z
+             */
+            readonly updatedAt: Date;
+            /**
+             * Deletion Time
+             * Format: date-time
+             * @description Timestamp of when the resource was permanently deleted.
+             * @example 2024-01-01T01:01:01.001Z
+             */
+            readonly deletedAt?: Date;
+            /**
+             * Format: double
+             * @description The amount to grant. Should be a positive number.
+             * @example 100
+             */
+            amount: number;
+            /**
+             * Format: uint8
+             * @description The priority of the grant. Grants with higher priority are applied first.
+             *     Priority is a positive decimal numbers. With lower numbers indicating higher importance.
+             *     For example, a priority of 1 is more urgent than a priority of 2.
+             *     When there are several grants available for the same subject, the system selects the grant with the highest priority.
+             *     In cases where grants share the same priority level, the grant closest to its expiration will be used first.
+             *     In the case of two grants have identical priorities and expiration dates, the system will use the grant that was created first.
+             * @example 1
+             */
+            priority?: number;
+            /**
+             * Format: date-time
+             * @description Effective date for grants and anchor for recurring grants. Provided value will be ceiled to metering windowSize (minute).
+             * @example 2023-01-01T01:01:01.001Z
+             */
+            effectiveAt: Date;
+            /**
+             * Format: double
+             * @description Grants are rolled over at reset, after which they can have a different balance compared to what they had before the reset.
+             *     Balance after the reset is calculated as: Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
+             * @default 0
+             * @example 100
+             */
+            minRolloverAmount?: number;
+            /**
+             * Format: double
+             * @description Grants are rolled over at reset, after which they can have a different balance compared to what they had before the reset. The default value equals grant amount.
+             *     Balance after the reset is calculated as: Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
+             * @example 100
+             */
+            maxRolloverAmount?: number;
+            /** @description The grant expiration definition. If no expiration is provided, the grant can be active indefinitely. */
+            expiration?: components['schemas']['ExpirationPeriod'];
+            /**
+             * @deprecated
+             * @description The grant metadata.
+             * @example {
+             *       "stripePaymentId": "pi_4OrAkhLvyihio9p51h9iiFnB"
+             *     }
+             */
+            metadata?: components['schemas']['Metadata'];
+            /**
+             * @description The grant metadata.
+             * @example {
+             *       "stripePaymentId": "pi_4OrAkhLvyihio9p51h9iiFnB"
+             *     }
+             */
+            annotations?: components['schemas']['Annotations'];
+            /**
+             * @description Readonly unique ULID identifier.
+             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
+             */
+            readonly id: string;
+            /**
+             * @description The unique entitlement ULID that the grant is associated with.
+             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
+             */
+            readonly entitlementId: string;
+            /**
+             * Format: date-time
+             * @description The next time the grant will recurr.
+             * @example 2023-01-01T01:01:01.001Z
+             */
+            nextRecurrence?: Date;
+            /**
+             * Format: date-time
+             * @description The time the grant expires.
+             * @example 2023-01-01T01:01:01.001Z
+             */
+            readonly expiresAt?: Date;
+            /**
+             * Format: date-time
+             * @description The time the grant was voided.
+             * @example 2023-01-01T01:01:01.001Z
+             */
+            voidedAt?: Date;
+            /** @description The recurrence period of the grant. */
+            recurrence?: components['schemas']['RecurringPeriod'];
+        };
         /** @description Metered entitlements are useful for many different use cases, from setting up usage based access to implementing complex credit systems.
          *     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). */
         EntitlementMetered: {
@@ -4892,14 +5061,15 @@ export interface components {
              */
             isSoftLimit?: boolean;
             /**
-             * @deprecated
-             * @description Deprecated, ignored by the backend. Please use isSoftLimit instead; this field will be removed in the future.
+             * Preserve overage at reset
+             * @description If true, the overage is preserved at reset. If false, the usage is reset to 0.
              * @default false
              */
-            isUnlimited?: boolean;
+            preserveOverageAtReset?: boolean;
             /**
              * Initial grant amount
              * Format: double
+             * @deprecated
              * @description You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.
              *     If an amount is specified here, a grant will be created alongside the entitlement with the specified amount.
              *     That grant will have it's rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.
@@ -4909,16 +5079,16 @@ export interface components {
             /**
              * Issue grant after reset priority
              * Format: uint8
+             * @deprecated
              * @description Defines the grant priority for the default grant.
              * @default 1
              */
             issueAfterResetPriority?: number;
             /**
-             * Preserve overage at reset
-             * @description If true, the overage is preserved at reset. If false, the usage is reset to 0.
-             * @default false
+             * Issue after reset
+             * @description Issue after reset
              */
-            preserveOverageAtReset?: boolean;
+            issue?: components['schemas']['IssueAfterReset'];
             /**
              * Creation Time
              * Format: date-time
@@ -5003,6 +5173,72 @@ export interface components {
              */
             customerId: string;
         };
+        /** @description Create inputs for metered entitlement */
+        EntitlementMeteredV2CreateInputs: {
+            /**
+             * @description The feature the subject is entitled to use.
+             *     Either featureKey or featureId is required.
+             * @example example-feature-key
+             */
+            featureKey?: string;
+            /**
+             * @description The feature the subject is entitled to use.
+             *     Either featureKey or featureId is required.
+             * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
+             */
+            featureId?: string;
+            /** @description Additional metadata for the feature. */
+            metadata?: components['schemas']['Metadata'];
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'metered';
+            /**
+             * Soft limit
+             * @description If softLimit=true the subject can use the feature even if the entitlement is exhausted, hasAccess will always be true.
+             * @default false
+             */
+            isSoftLimit?: boolean;
+            /** @description The usage period associated with the entitlement. */
+            usagePeriod: components['schemas']['RecurringPeriodCreateInput'];
+            /** @description Defines the time from which usage is measured. If not specified on creation, defaults to entitlement creation time. */
+            measureUsageFrom?: components['schemas']['MeasureUsageFrom'];
+            /**
+             * Preserve overage at reset
+             * @description If true, the overage is preserved at reset. If false, the usage is reset to 0.
+             * @default false
+             */
+            preserveOverageAtReset?: boolean;
+            /**
+             * Initial grant amount
+             * Format: double
+             * @deprecated
+             * @description You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.
+             *     If an amount is specified here, a grant will be created alongside the entitlement with the specified amount.
+             *     That grant will have it's rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.
+             *     Manually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.
+             */
+            issueAfterReset?: number;
+            /**
+             * Issue grant after reset priority
+             * Format: uint8
+             * @deprecated
+             * @description Defines the grant priority for the default grant.
+             * @default 1
+             */
+            issueAfterResetPriority?: number;
+            /**
+             * Issue after reset
+             * @description Issue after reset
+             */
+            issue?: components['schemas']['IssueAfterReset'];
+            /**
+             * Grants
+             * @description Grants
+             */
+            grants?: components['schemas']['EntitlementGrantCreateInputV2'][];
+        };
         /**
          * @description Order by options for entitlements.
          * @enum {string}
@@ -5232,6 +5468,8 @@ export interface components {
         /** @description Entitlement templates are used to define the entitlements of a plan.
          *     Features are omitted from the entitlement template, as they are defined in the rate card. */
         EntitlementV2: components['schemas']['EntitlementMeteredV2'] | components['schemas']['EntitlementStaticV2'] | components['schemas']['EntitlementBooleanV2'];
+        /** @description Create inputs for entitlement */
+        EntitlementV2CreateInputs: components['schemas']['EntitlementMeteredV2CreateInputs'] | components['schemas']['EntitlementStaticCreateInputs'] | components['schemas']['EntitlementBooleanCreateInputs'];
         /** @description Paginated response */
         EntitlementV2PaginatedResponse: {
             /**
@@ -5697,6 +5935,26 @@ export interface components {
              */
             usage: number;
         };
+        /** @description Paginated response */
+        GrantV2PaginatedResponse: {
+            /**
+             * @description The total number of items.
+             * @example 500
+             */
+            totalCount: number;
+            /**
+             * @description The page index.
+             * @example 1
+             */
+            page: number;
+            /**
+             * @description The maximum number of items per page.
+             * @example 100
+             */
+            pageSize: number;
+            /** @description The items in the current page. */
+            items: components['schemas']['EntitlementGrantV2'][];
+        };
         /** @description IDResource is a resouce with an ID. */
         IDResource: {
             /**
@@ -6805,6 +7063,22 @@ export interface components {
             /** @description The payment settings for this workflow */
             payment: components['schemas']['BillingWorkflowPaymentSettings'];
         };
+        /** @description Issue after reset */
+        IssueAfterReset: {
+            /**
+             * Initial grant amount
+             * Format: double
+             * @description The initial grant amount
+             */
+            amount: number;
+            /**
+             * Issue grant after reset priority
+             * Format: uint8
+             * @description The priority of the issue after reset
+             * @default 1
+             */
+            priority?: number;
+        };
         /** @description List entitlements result */
         ListEntitlementsResult: components['schemas']['Entitlement'][] | components['schemas']['EntitlementPaginatedResponse'];
         /** @description List features result */
@@ -11029,9 +11303,12 @@ export type EntitlementBooleanV2 = components['schemas']['EntitlementBooleanV2']
 export type EntitlementCreateInputs = components['schemas']['EntitlementCreateInputs'];
 export type EntitlementGrant = components['schemas']['EntitlementGrant'];
 export type EntitlementGrantCreateInput = components['schemas']['EntitlementGrantCreateInput'];
+export type EntitlementGrantCreateInputV2 = components['schemas']['EntitlementGrantCreateInputV2'];
+export type EntitlementGrantV2 = components['schemas']['EntitlementGrantV2'];
 export type EntitlementMetered = components['schemas']['EntitlementMetered'];
 export type EntitlementMeteredCreateInputs = components['schemas']['EntitlementMeteredCreateInputs'];
 export type EntitlementMeteredV2 = components['schemas']['EntitlementMeteredV2'];
+export type EntitlementMeteredV2CreateInputs = components['schemas']['EntitlementMeteredV2CreateInputs'];
 export type EntitlementOrderBy = components['schemas']['EntitlementOrderBy'];
 export type EntitlementPaginatedResponse = components['schemas']['EntitlementPaginatedResponse'];
 export type EntitlementStatic = components['schemas']['EntitlementStatic'];
@@ -11039,6 +11316,7 @@ export type EntitlementStaticCreateInputs = components['schemas']['EntitlementSt
 export type EntitlementStaticV2 = components['schemas']['EntitlementStaticV2'];
 export type EntitlementType = components['schemas']['EntitlementType'];
 export type EntitlementV2 = components['schemas']['EntitlementV2'];
+export type EntitlementV2CreateInputs = components['schemas']['EntitlementV2CreateInputs'];
 export type EntitlementV2PaginatedResponse = components['schemas']['EntitlementV2PaginatedResponse'];
 export type EntitlementValue = components['schemas']['EntitlementValue'];
 export type Event = components['schemas']['Event'];
@@ -11060,6 +11338,7 @@ export type GrantBurnDownHistorySegment = components['schemas']['GrantBurnDownHi
 export type GrantOrderBy = components['schemas']['GrantOrderBy'];
 export type GrantPaginatedResponse = components['schemas']['GrantPaginatedResponse'];
 export type GrantUsageRecord = components['schemas']['GrantUsageRecord'];
+export type GrantV2PaginatedResponse = components['schemas']['GrantV2PaginatedResponse'];
 export type IdResource = components['schemas']['IDResource'];
 export type IngestEventsBody = components['schemas']['IngestEventsBody'];
 export type IngestedEvent = components['schemas']['IngestedEvent'];
@@ -11111,6 +11390,7 @@ export type InvoiceWorkflowInvoicingSettingsReplaceUpdate = components['schemas'
 export type InvoiceWorkflowReplaceUpdate = components['schemas']['InvoiceWorkflowReplaceUpdate'];
 export type InvoiceWorkflowSettings = components['schemas']['InvoiceWorkflowSettings'];
 export type InvoiceWorkflowSettingsReplaceUpdate = components['schemas']['InvoiceWorkflowSettingsReplaceUpdate'];
+export type IssueAfterReset = components['schemas']['IssueAfterReset'];
 export type ListEntitlementsResult = components['schemas']['ListEntitlementsResult'];
 export type ListFeaturesResult = components['schemas']['ListFeaturesResult'];
 export type MarketplaceInstallRequestPayload = components['schemas']['MarketplaceInstallRequestPayload'];
@@ -24741,7 +25021,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                'application/json': components['schemas']['EntitlementCreateInputs'];
+                'application/json': components['schemas']['EntitlementV2CreateInputs'];
             };
         };
         responses: {
@@ -25056,7 +25336,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    'application/json': components['schemas']['GrantPaginatedResponse'];
+                    'application/json': components['schemas']['GrantV2PaginatedResponse'];
                 };
             };
             /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
@@ -25136,7 +25416,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                'application/json': components['schemas']['EntitlementGrantCreateInput'];
+                'application/json': components['schemas']['EntitlementGrantCreateInputV2'];
             };
         };
         responses: {
@@ -25146,7 +25426,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    'application/json': components['schemas']['EntitlementGrant'];
+                    'application/json': components['schemas']['EntitlementGrantV2'];
                 };
             };
             /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
@@ -25340,7 +25620,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                'application/json': components['schemas']['EntitlementCreateInputs'];
+                'application/json': components['schemas']['EntitlementV2CreateInputs'];
             };
         };
         responses: {
@@ -25985,7 +26265,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    'application/json': components['schemas']['GrantPaginatedResponse'];
+                    'application/json': components['schemas']['GrantV2PaginatedResponse'];
                 };
             };
             /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */