@stigg/typescript 0.1.0-alpha.18 → 0.1.0-alpha.19

package/resources/v1/addons/entitlements.d.mts

@@ -24,39 +24,27 @@ export declare class Entitlements extends APIResource {
  */
 export interface AddonPackageEntitlement {
     /**
-     * Feature or credit entitlement on an addon
+     * Feature entitlement response
      */
-    data: AddonPackageEntitlement.Data;
+    data: AddonPackageEntitlement.Feature | AddonPackageEntitlement.Credit;
 }
 export declare namespace AddonPackageEntitlement {
     /**
-     * Feature or credit entitlement on an addon
+     * Feature entitlement response
      */
-    interface Data {
+    interface Feature {
         /**
          * Unique identifier of the entitlement
          */
         id: string;
-        /**
-         * Credit amount (for credit entitlements)
-         */
-        amount: number | null;
         /**
          * Entitlement behavior (Increment or Override)
          */
         behavior: 'Increment' | 'Override';
-        /**
-         * Credit grant cadence (for credit entitlements)
-         */
-        cadence: 'MONTH' | 'YEAR' | null;
         /**
          * Timestamp of when the record was created
          */
         createdAt: string;
-        /**
-         * Custom currency ID (for credit entitlements)
-         */
-        customCurrencyId: string | null;
         /**
          * Optional description of the entitlement
          */
@@ -69,10 +57,6 @@ export declare namespace AddonPackageEntitlement {
          * Allowed enum values (for feature entitlements)
          */
         enumValues: Array<string> | null;
-        /**
-         * Feature ID (for feature entitlements)
-         */
-        featureId: string | null;
         /**
          * Whether the usage limit is a soft limit (for feature entitlements)
          */
@@ -104,11 +88,11 @@ export declare namespace AddonPackageEntitlement {
         /**
          * Reset period configuration (for feature entitlements)
          */
-        resetPeriodConfiguration: Data.YearlyResetPeriodConfig | Data.MonthlyResetPeriodConfig | Data.WeeklyResetPeriodConfig | null;
+        resetPeriodConfiguration: Feature.YearlyResetPeriodConfig | Feature.MonthlyResetPeriodConfig | Feature.WeeklyResetPeriodConfig | null;
         /**
          * Entitlement type (FEATURE or CREDIT)
          */
-        type: 'FEATURE' | 'CREDIT';
+        type: 'FEATURE';
         /**
          * Timestamp of when the record was last updated
          */
@@ -118,7 +102,7 @@ export declare namespace AddonPackageEntitlement {
          */
         usageLimit: number | null;
     }
-    namespace Data {
+    namespace Feature {
         /**
          * Yearly reset configuration
          */
@@ -147,18 +131,10 @@ export declare namespace AddonPackageEntitlement {
             accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
         }
     }
-}
-/**
- * Response object
- */
-export interface EntitlementCreateResponse {
-    data: Array<EntitlementCreateResponse.Data>;
-}
-export declare namespace EntitlementCreateResponse {
     /**
-     * Feature or credit entitlement on an addon
+     * Credit entitlement response
      */
-    interface Data {
+    interface Credit {
         /**
          * Unique identifier of the entitlement
          */
@@ -180,9 +156,62 @@ export declare namespace EntitlementCreateResponse {
          */
         createdAt: string;
         /**
-         * Custom currency ID (for credit entitlements)
+         * Optional description of the entitlement
+         */
+        description: string | null;
+        /**
+         * Override display name for the entitlement
+         */
+        displayNameOverride: string | null;
+        /**
+         * Widget types where this entitlement is hidden
+         */
+        hiddenFromWidgets: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
+        /**
+         * Whether this is a custom entitlement
+         */
+        isCustom: boolean | null;
+        /**
+         * Whether the entitlement is granted
+         */
+        isGranted: boolean;
+        /**
+         * Display order of the entitlement
+         */
+        order: number | null;
+        /**
+         * Entitlement type (FEATURE or CREDIT)
+         */
+        type: 'CREDIT';
+        /**
+         * Timestamp of when the record was last updated
+         */
+        updatedAt: string;
+    }
+}
+/**
+ * Response object
+ */
+export interface EntitlementCreateResponse {
+    data: Array<EntitlementCreateResponse.Feature | EntitlementCreateResponse.Credit>;
+}
+export declare namespace EntitlementCreateResponse {
+    /**
+     * Feature entitlement response
+     */
+    interface Feature {
+        /**
+         * Unique identifier of the entitlement
+         */
+        id: string;
+        /**
+         * Entitlement behavior (Increment or Override)
          */
-        customCurrencyId: string | null;
+        behavior: 'Increment' | 'Override';
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
         /**
          * Optional description of the entitlement
          */
@@ -195,10 +224,6 @@ export declare namespace EntitlementCreateResponse {
          * Allowed enum values (for feature entitlements)
          */
         enumValues: Array<string> | null;
-        /**
-         * Feature ID (for feature entitlements)
-         */
-        featureId: string | null;
         /**
          * Whether the usage limit is a soft limit (for feature entitlements)
          */
@@ -230,11 +255,11 @@ export declare namespace EntitlementCreateResponse {
         /**
          * Reset period configuration (for feature entitlements)
          */
-        resetPeriodConfiguration: Data.YearlyResetPeriodConfig | Data.MonthlyResetPeriodConfig | Data.WeeklyResetPeriodConfig | null;
+        resetPeriodConfiguration: Feature.YearlyResetPeriodConfig | Feature.MonthlyResetPeriodConfig | Feature.WeeklyResetPeriodConfig | null;
         /**
          * Entitlement type (FEATURE or CREDIT)
          */
-        type: 'FEATURE' | 'CREDIT';
+        type: 'FEATURE';
         /**
          * Timestamp of when the record was last updated
          */
@@ -244,7 +269,7 @@ export declare namespace EntitlementCreateResponse {
          */
         usageLimit: number | null;
     }
-    namespace Data {
+    namespace Feature {
         /**
          * Yearly reset configuration
          */
@@ -273,12 +298,69 @@ export declare namespace EntitlementCreateResponse {
             accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
         }
     }
+    /**
+     * Credit entitlement response
+     */
+    interface Credit {
+        /**
+         * Unique identifier of the entitlement
+         */
+        id: string;
+        /**
+         * Credit amount (for credit entitlements)
+         */
+        amount: number | null;
+        /**
+         * Entitlement behavior (Increment or Override)
+         */
+        behavior: 'Increment' | 'Override';
+        /**
+         * Credit grant cadence (for credit entitlements)
+         */
+        cadence: 'MONTH' | 'YEAR' | null;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
+        /**
+         * Optional description of the entitlement
+         */
+        description: string | null;
+        /**
+         * Override display name for the entitlement
+         */
+        displayNameOverride: string | null;
+        /**
+         * Widget types where this entitlement is hidden
+         */
+        hiddenFromWidgets: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
+        /**
+         * Whether this is a custom entitlement
+         */
+        isCustom: boolean | null;
+        /**
+         * Whether the entitlement is granted
+         */
+        isGranted: boolean;
+        /**
+         * Display order of the entitlement
+         */
+        order: number | null;
+        /**
+         * Entitlement type (FEATURE or CREDIT)
+         */
+        type: 'CREDIT';
+        /**
+         * Timestamp of when the record was last updated
+         */
+        updatedAt: string;
+    }
 }
 /**
  * Response list object
  */
 export interface EntitlementListResponse {
-    data: Array<EntitlementListResponse.Data>;
+    data: Array<EntitlementListResponse.Feature | EntitlementListResponse.Credit>;
     /**
      * Pagination metadata including cursors for navigating through results
      */
@@ -286,33 +368,21 @@ export interface EntitlementListResponse {
 }
 export declare namespace EntitlementListResponse {
     /**
-     * Feature or credit entitlement on an addon
+     * Feature entitlement response
      */
-    interface Data {
+    interface Feature {
         /**
          * Unique identifier of the entitlement
          */
         id: string;
-        /**
-         * Credit amount (for credit entitlements)
-         */
-        amount: number | null;
         /**
          * Entitlement behavior (Increment or Override)
          */
         behavior: 'Increment' | 'Override';
-        /**
-         * Credit grant cadence (for credit entitlements)
-         */
-        cadence: 'MONTH' | 'YEAR' | null;
         /**
          * Timestamp of when the record was created
          */
         createdAt: string;
-        /**
-         * Custom currency ID (for credit entitlements)
-         */
-        customCurrencyId: string | null;
         /**
          * Optional description of the entitlement
          */
@@ -325,10 +395,6 @@ export declare namespace EntitlementListResponse {
          * Allowed enum values (for feature entitlements)
          */
         enumValues: Array<string> | null;
-        /**
-         * Feature ID (for feature entitlements)
-         */
-        featureId: string | null;
         /**
          * Whether the usage limit is a soft limit (for feature entitlements)
          */
@@ -360,11 +426,11 @@ export declare namespace EntitlementListResponse {
         /**
          * Reset period configuration (for feature entitlements)
          */
-        resetPeriodConfiguration: Data.YearlyResetPeriodConfig | Data.MonthlyResetPeriodConfig | Data.WeeklyResetPeriodConfig | null;
+        resetPeriodConfiguration: Feature.YearlyResetPeriodConfig | Feature.MonthlyResetPeriodConfig | Feature.WeeklyResetPeriodConfig | null;
         /**
          * Entitlement type (FEATURE or CREDIT)
          */
-        type: 'FEATURE' | 'CREDIT';
+        type: 'FEATURE';
         /**
          * Timestamp of when the record was last updated
          */
@@ -374,7 +440,7 @@ export declare namespace EntitlementListResponse {
          */
         usageLimit: number | null;
     }
-    namespace Data {
+    namespace Feature {
         /**
          * Yearly reset configuration
          */
@@ -403,6 +469,63 @@ export declare namespace EntitlementListResponse {
             accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
         }
     }
+    /**
+     * Credit entitlement response
+     */
+    interface Credit {
+        /**
+         * Unique identifier of the entitlement
+         */
+        id: string;
+        /**
+         * Credit amount (for credit entitlements)
+         */
+        amount: number | null;
+        /**
+         * Entitlement behavior (Increment or Override)
+         */
+        behavior: 'Increment' | 'Override';
+        /**
+         * Credit grant cadence (for credit entitlements)
+         */
+        cadence: 'MONTH' | 'YEAR' | null;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
+        /**
+         * Optional description of the entitlement
+         */
+        description: string | null;
+        /**
+         * Override display name for the entitlement
+         */
+        displayNameOverride: string | null;
+        /**
+         * Widget types where this entitlement is hidden
+         */
+        hiddenFromWidgets: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
+        /**
+         * Whether this is a custom entitlement
+         */
+        isCustom: boolean | null;
+        /**
+         * Whether the entitlement is granted
+         */
+        isGranted: boolean;
+        /**
+         * Display order of the entitlement
+         */
+        order: number | null;
+        /**
+         * Entitlement type (FEATURE or CREDIT)
+         */
+        type: 'CREDIT';
+        /**
+         * Timestamp of when the record was last updated
+         */
+        updatedAt: string;
+    }
     /**
      * Pagination metadata including cursors for navigating through results
      */
@@ -422,199 +545,135 @@ export interface EntitlementCreateParams {
     /**
      * Entitlements to create
      */
-    entitlements: Array<EntitlementCreateParams.Entitlement>;
+    entitlements: Array<EntitlementCreateParams.Feature | EntitlementCreateParams.Credit>;
 }
 export declare namespace EntitlementCreateParams {
     /**
-     * A single entitlement to create. Provide exactly one of feature or credit.
+     * Request to create a feature entitlement
      */
-    interface Entitlement {
+    interface Feature {
+        /**
+         * The feature ID to attach the entitlement to
+         */
+        id: string;
+        /**
+         * CreateFeatureEntitlementRequest
+         */
+        type: 'FEATURE';
         /**
-         * Credit entitlement to create
+         * Entitlement behavior (Increment or Override)
+         */
+        behavior?: 'Increment' | 'Override';
+        /**
+         * Description of the entitlement
+         */
+        description?: string;
+        /**
+         * Override display name for the entitlement
+         */
+        displayNameOverride?: string;
+        /**
+         * Allowed enum values for the feature entitlement
+         */
+        enumValues?: Array<string>;
+        /**
+         * Whether the usage limit is a soft limit
+         */
+        hasSoftLimit?: boolean;
+        /**
+         * Whether usage is unlimited
+         */
+        hasUnlimitedUsage?: boolean;
+        /**
+         * Widget types where this entitlement is hidden
+         */
+        hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
+        /**
+         * Whether this is a custom entitlement
+         */
+        isCustom?: boolean;
+        /**
+         * Whether the entitlement is granted
+         */
+        isGranted?: boolean;
+        /**
+         * Configuration for monthly reset period
+         */
+        monthlyResetPeriodConfiguration?: Feature.MonthlyResetPeriodConfiguration | null;
+        /**
+         * Display order of the entitlement
+         */
+        order?: number;
+        /**
+         * Period at which usage resets
+         */
+        resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
+        /**
+         * Maximum allowed usage for the feature
+         */
+        usageLimit?: number | null;
+        /**
+         * Configuration for weekly reset period
          */
-        credit?: Entitlement.Credit;
+        weeklyResetPeriodConfiguration?: Feature.WeeklyResetPeriodConfiguration | null;
         /**
-         * Feature entitlement to create
+         * Configuration for yearly reset period
          */
-        feature?: Entitlement.Feature;
+        yearlyResetPeriodConfiguration?: Feature.YearlyResetPeriodConfiguration | null;
     }
-    namespace Entitlement {
+    namespace Feature {
         /**
-         * Credit entitlement to create
+         * Configuration for monthly reset period
          */
-        interface Credit {
-            /**
-             * Credit grant amount
-             */
-            amount: number | null;
-            /**
-             * Credit grant cadence (MONTH or YEAR)
-             */
-            cadence: 'MONTH' | 'YEAR';
-            /**
-             * The custom currency ID for the credit entitlement
-             */
-            customCurrencyId: string;
-            /**
-             * Entitlement behavior (Increment or Override)
-             */
-            behavior?: 'Increment' | 'Override';
-            /**
-             * Description of the entitlement
-             */
-            description?: string;
-            /**
-             * Override display name for the entitlement
-             */
-            displayNameOverride?: string;
-            /**
-             * Widget types where this entitlement is hidden
-             */
-            hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
-            /**
-             * Whether this is a custom entitlement
-             */
-            isCustom?: boolean;
-            /**
-             * Whether the entitlement is granted
-             */
-            isGranted?: boolean;
+        interface MonthlyResetPeriodConfiguration {
             /**
-             * Display order of the entitlement
+             * Reset anchor (SubscriptionStart or StartOfTheMonth)
              */
-            order?: number;
+            accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
         }
         /**
-         * Feature entitlement to create
+         * Configuration for weekly reset period
          */
-        interface Feature {
-            /**
-             * The feature ID to attach the entitlement to
-             */
-            featureId: string;
-            /**
-             * Entitlement behavior (Increment or Override)
-             */
-            behavior?: 'Increment' | 'Override';
-            /**
-             * Description of the entitlement
-             */
-            description?: string;
-            /**
-             * Override display name for the entitlement
-             */
-            displayNameOverride?: string;
-            /**
-             * Allowed enum values for the feature entitlement
-             */
-            enumValues?: Array<string>;
-            /**
-             * Whether the usage limit is a soft limit
-             */
-            hasSoftLimit?: boolean;
-            /**
-             * Whether usage is unlimited
-             */
-            hasUnlimitedUsage?: boolean;
-            /**
-             * Widget types where this entitlement is hidden
-             */
-            hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
-            /**
-             * Whether this is a custom entitlement
-             */
-            isCustom?: boolean;
-            /**
-             * Whether the entitlement is granted
-             */
-            isGranted?: boolean;
-            /**
-             * Configuration for monthly reset period
-             */
-            monthlyResetPeriodConfiguration?: Feature.MonthlyResetPeriodConfiguration | null;
-            /**
-             * Display order of the entitlement
-             */
-            order?: number;
-            /**
-             * Period at which usage resets
-             */
-            resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
-            /**
-             * Maximum allowed usage for the feature
-             */
-            usageLimit?: number | null;
-            /**
-             * Configuration for weekly reset period
-             */
-            weeklyResetPeriodConfiguration?: Feature.WeeklyResetPeriodConfiguration | null;
+        interface WeeklyResetPeriodConfiguration {
             /**
-             * Configuration for yearly reset period
+             * Reset anchor (SubscriptionStart or specific day)
              */
-            yearlyResetPeriodConfiguration?: Feature.YearlyResetPeriodConfiguration | null;
+            accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
         }
-        namespace Feature {
-            /**
-             * Configuration for monthly reset period
-             */
-            interface MonthlyResetPeriodConfiguration {
-                /**
-                 * Reset anchor (SubscriptionStart or StartOfTheMonth)
-                 */
-                accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
-            }
-            /**
-             * Configuration for weekly reset period
-             */
-            interface WeeklyResetPeriodConfiguration {
-                /**
-                 * Reset anchor (SubscriptionStart or specific day)
-                 */
-                accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
-            }
+        /**
+         * Configuration for yearly reset period
+         */
+        interface YearlyResetPeriodConfiguration {
             /**
-             * Configuration for yearly reset period
+             * Reset anchor (SubscriptionStart)
              */
-            interface YearlyResetPeriodConfiguration {
-                /**
-                 * Reset anchor (SubscriptionStart)
-                 */
-                accordingTo: 'SubscriptionStart';
-            }
+            accordingTo: 'SubscriptionStart';
         }
     }
-}
-export interface EntitlementUpdateParams {
-    /**
-     * Path param: The addon ID
-     */
-    addonId: string;
-    /**
-     * Body param: Credit entitlement fields to update
-     */
-    credit?: EntitlementUpdateParams.Credit;
-    /**
-     * Body param: Feature entitlement fields to update
-     */
-    feature?: EntitlementUpdateParams.Feature;
-}
-export declare namespace EntitlementUpdateParams {
     /**
-     * Credit entitlement fields to update
+     * Request to create a credit entitlement
      */
     interface Credit {
         /**
-         * Credit grant amount
+         * The custom currency ID for the credit entitlement
          */
-        amount?: number;
+        id: string;
         /**
-         * Entitlement behavior (Increment or Override)
+         * Credit grant amount
          */
-        behavior?: 'Increment' | 'Override';
+        amount: number | null;
         /**
          * Credit grant cadence (MONTH or YEAR)
          */
-        cadence?: 'MONTH' | 'YEAR';
+        cadence: 'MONTH' | 'YEAR';
+        /**
+         * CreateCreditEntitlementRequest
+         */
+        type: 'CREDIT';
+        /**
+         * Entitlement behavior (Increment or Override)
+         */
+        behavior?: 'Increment' | 'Override';
         /**
          * Description of the entitlement
          */
@@ -640,72 +699,80 @@ export declare namespace EntitlementUpdateParams {
          */
         order?: number;
     }
-    /**
-     * Feature entitlement fields to update
-     */
-    interface Feature {
+}
+export type EntitlementUpdateParams = EntitlementUpdateParams.UpdateFeatureEntitlementRequest | EntitlementUpdateParams.UpdateCreditEntitlementRequest;
+export declare namespace EntitlementUpdateParams {
+    interface UpdateFeatureEntitlementRequest {
         /**
-         * Entitlement behavior (Increment or Override)
+         * Path param: The addon ID
+         */
+        addonId: string;
+        /**
+         * Body param: UpdateFeatureEntitlementRequest
+         */
+        type: 'FEATURE';
+        /**
+         * Body param: Entitlement behavior (Increment or Override)
          */
         behavior?: 'Increment' | 'Override';
         /**
-         * Description of the entitlement
+         * Body param: Description of the entitlement
          */
         description?: string;
         /**
-         * Override display name for the entitlement
+         * Body param: Override display name for the entitlement
          */
         displayNameOverride?: string;
         /**
-         * Allowed enum values for the feature entitlement
+         * Body param: Allowed enum values for the feature entitlement
          */
         enumValues?: Array<string>;
         /**
-         * Whether the usage limit is a soft limit
+         * Body param: Whether the usage limit is a soft limit
          */
         hasSoftLimit?: boolean;
         /**
-         * Whether usage is unlimited
+         * Body param: Whether usage is unlimited
          */
         hasUnlimitedUsage?: boolean;
         /**
-         * Widget types where this entitlement is hidden
+         * Body param: Widget types where this entitlement is hidden
          */
         hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
         /**
-         * Whether this is a custom entitlement
+         * Body param: Whether this is a custom entitlement
          */
         isCustom?: boolean;
         /**
-         * Whether the entitlement is granted
+         * Body param: Whether the entitlement is granted
          */
         isGranted?: boolean;
         /**
-         * Configuration for monthly reset period
+         * Body param: Configuration for monthly reset period
          */
-        monthlyResetPeriodConfiguration?: Feature.MonthlyResetPeriodConfiguration | null;
+        monthlyResetPeriodConfiguration?: UpdateFeatureEntitlementRequest.MonthlyResetPeriodConfiguration | null;
         /**
-         * Display order of the entitlement
+         * Body param: Display order of the entitlement
          */
         order?: number;
         /**
-         * Period at which usage resets
+         * Body param: Period at which usage resets
          */
         resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
         /**
-         * Maximum allowed usage for the feature
+         * Body param: Maximum allowed usage for the feature
          */
         usageLimit?: number | null;
         /**
-         * Configuration for weekly reset period
+         * Body param: Configuration for weekly reset period
          */
-        weeklyResetPeriodConfiguration?: Feature.WeeklyResetPeriodConfiguration | null;
+        weeklyResetPeriodConfiguration?: UpdateFeatureEntitlementRequest.WeeklyResetPeriodConfiguration | null;
         /**
-         * Configuration for yearly reset period
+         * Body param: Configuration for yearly reset period
          */
-        yearlyResetPeriodConfiguration?: Feature.YearlyResetPeriodConfiguration | null;
+        yearlyResetPeriodConfiguration?: UpdateFeatureEntitlementRequest.YearlyResetPeriodConfiguration | null;
     }
-    namespace Feature {
+    namespace UpdateFeatureEntitlementRequest {
         /**
          * Configuration for monthly reset period
          */
@@ -734,6 +801,52 @@ export declare namespace EntitlementUpdateParams {
             accordingTo: 'SubscriptionStart';
         }
     }
+    interface UpdateCreditEntitlementRequest {
+        /**
+         * Path param: The addon ID
+         */
+        addonId: string;
+        /**
+         * Body param: UpdateCreditEntitlementRequest
+         */
+        type: 'CREDIT';
+        /**
+         * Body param: Credit grant amount
+         */
+        amount?: number;
+        /**
+         * Body param: Entitlement behavior (Increment or Override)
+         */
+        behavior?: 'Increment' | 'Override';
+        /**
+         * Body param: Credit grant cadence (MONTH or YEAR)
+         */
+        cadence?: 'MONTH' | 'YEAR';
+        /**
+         * Body param: Description of the entitlement
+         */
+        description?: string;
+        /**
+         * Body param: Override display name for the entitlement
+         */
+        displayNameOverride?: string;
+        /**
+         * Body param: Widget types where this entitlement is hidden
+         */
+        hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
+        /**
+         * Body param: Whether this is a custom entitlement
+         */
+        isCustom?: boolean;
+        /**
+         * Body param: Whether the entitlement is granted
+         */
+        isGranted?: boolean;
+        /**
+         * Body param: Display order of the entitlement
+         */
+        order?: number;
+    }
 }
 export interface EntitlementDeleteParams {
     /**