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

package/src/resources/v1/plans/entitlements.ts

@@ -46,46 +46,31 @@ export class Entitlements extends APIResource {
  */
 export interface PlanEntitlement {
   /**
-   * Feature or credit entitlement on a plan
+   * Feature entitlement response
    */
-  data: PlanEntitlement.Data;
+  data: PlanEntitlement.Feature | PlanEntitlement.Credit;
 }
 
 export namespace PlanEntitlement {
   /**
-   * Feature or credit entitlement on a plan
+   * Feature entitlement response
    */
-  export interface Data {
+  export 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
      */
@@ -101,11 +86,6 @@ export namespace PlanEntitlement {
      */
     enumValues: Array<string> | null;
 
-    /**
-     * Feature ID (for feature entitlements)
-     */
-    featureId: string | null;
-
     /**
      * Whether the usage limit is a soft limit (for feature entitlements)
      */
@@ -145,15 +125,15 @@ export namespace PlanEntitlement {
      * Reset period configuration (for feature entitlements)
      */
     resetPeriodConfiguration:
-      | Data.YearlyResetPeriodConfig
-      | Data.MonthlyResetPeriodConfig
-      | Data.WeeklyResetPeriodConfig
+      | 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
@@ -166,7 +146,7 @@ export namespace PlanEntitlement {
     usageLimit: number | null;
   }
 
-  export namespace Data {
+  export namespace Feature {
     /**
      * Yearly reset configuration
      */
@@ -205,20 +185,11 @@ export namespace PlanEntitlement {
         | 'EverySaturday';
     }
   }
-}
-
-/**
- * Response object
- */
-export interface EntitlementCreateResponse {
-  data: Array<EntitlementCreateResponse.Data>;
-}
 
-export namespace EntitlementCreateResponse {
   /**
-   * Feature or credit entitlement on a plan
+   * Credit entitlement response
    */
-  export interface Data {
+  export interface Credit {
     /**
      * Unique identifier of the entitlement
      */
@@ -245,9 +216,73 @@ export 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 namespace EntitlementCreateResponse {
+  /**
+   * Feature entitlement response
+   */
+  export interface Feature {
+    /**
+     * Unique identifier of the entitlement
+     */
+    id: string;
+
+    /**
+     * Entitlement behavior (Increment or Override)
+     */
+    behavior: 'Increment' | 'Override';
+
+    /**
+     * Timestamp of when the record was created
      */
-    customCurrencyId: string | null;
+    createdAt: string;
 
     /**
      * Optional description of the entitlement
@@ -264,11 +299,6 @@ export namespace EntitlementCreateResponse {
      */
     enumValues: Array<string> | null;
 
-    /**
-     * Feature ID (for feature entitlements)
-     */
-    featureId: string | null;
-
     /**
      * Whether the usage limit is a soft limit (for feature entitlements)
      */
@@ -308,15 +338,15 @@ export namespace EntitlementCreateResponse {
      * Reset period configuration (for feature entitlements)
      */
     resetPeriodConfiguration:
-      | Data.YearlyResetPeriodConfig
-      | Data.MonthlyResetPeriodConfig
-      | Data.WeeklyResetPeriodConfig
+      | 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
@@ -329,7 +359,7 @@ export namespace EntitlementCreateResponse {
     usageLimit: number | null;
   }
 
-  export namespace Data {
+  export namespace Feature {
     /**
      * Yearly reset configuration
      */
@@ -368,25 +398,11 @@ export namespace EntitlementCreateResponse {
         | 'EverySaturday';
     }
   }
-}
 
-/**
- * Response list object
- */
-export interface EntitlementListResponse {
-  data: Array<EntitlementListResponse.Data>;
-
-  /**
-   * Pagination metadata including cursors for navigating through results
-   */
-  pagination: EntitlementListResponse.Pagination;
-}
-
-export namespace EntitlementListResponse {
   /**
-   * Feature or credit entitlement on a plan
+   * Credit entitlement response
    */
-  export interface Data {
+  export interface Credit {
     /**
      * Unique identifier of the entitlement
      */
@@ -413,9 +429,78 @@ export namespace EntitlementListResponse {
     createdAt: string;
 
     /**
-     * Custom currency ID (for credit entitlements)
+     * Optional description of the entitlement
      */
-    customCurrencyId: string | null;
+    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.Feature | EntitlementListResponse.Credit>;
+
+  /**
+   * Pagination metadata including cursors for navigating through results
+   */
+  pagination: EntitlementListResponse.Pagination;
+}
+
+export namespace EntitlementListResponse {
+  /**
+   * Feature entitlement response
+   */
+  export interface Feature {
+    /**
+     * Unique identifier of the entitlement
+     */
+    id: string;
+
+    /**
+     * Entitlement behavior (Increment or Override)
+     */
+    behavior: 'Increment' | 'Override';
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
 
     /**
      * Optional description of the entitlement
@@ -432,11 +517,6 @@ export namespace EntitlementListResponse {
      */
     enumValues: Array<string> | null;
 
-    /**
-     * Feature ID (for feature entitlements)
-     */
-    featureId: string | null;
-
     /**
      * Whether the usage limit is a soft limit (for feature entitlements)
      */
@@ -476,15 +556,15 @@ export namespace EntitlementListResponse {
      * Reset period configuration (for feature entitlements)
      */
     resetPeriodConfiguration:
-      | Data.YearlyResetPeriodConfig
-      | Data.MonthlyResetPeriodConfig
-      | Data.WeeklyResetPeriodConfig
+      | 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
@@ -497,7 +577,7 @@ export namespace EntitlementListResponse {
     usageLimit: number | null;
   }
 
-  export namespace Data {
+  export namespace Feature {
     /**
      * Yearly reset configuration
      */
@@ -537,6 +617,76 @@ export namespace EntitlementListResponse {
     }
   }
 
+  /**
+   * Credit entitlement response
+   */
+  export 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
    */
@@ -558,244 +708,168 @@ export interface EntitlementCreateParams {
   /**
    * Entitlements to create
    */
-  entitlements: Array<EntitlementCreateParams.Entitlement>;
+  entitlements: Array<EntitlementCreateParams.Feature | EntitlementCreateParams.Credit>;
 }
 
 export namespace EntitlementCreateParams {
   /**
-   * A single entitlement to create. Provide exactly one of feature or credit.
+   * Request to create a feature entitlement
    */
-  export interface Entitlement {
+  export interface Feature {
     /**
-     * Credit entitlement to create
+     * The feature ID to attach the entitlement to
      */
-    credit?: Entitlement.Credit;
+    id: string;
 
     /**
-     * Feature entitlement to create
+     * CreateFeatureEntitlementRequest
      */
-    feature?: Entitlement.Feature;
-  }
+    type: 'FEATURE';
 
-  export namespace Entitlement {
     /**
-     * Credit entitlement to create
+     * Entitlement behavior (Increment or Override)
      */
-    export 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;
-
-      /**
-       * Display order of the entitlement
-       */
-      order?: number;
-    }
+    behavior?: 'Increment' | 'Override';
 
     /**
-     * Feature entitlement to create
+     * Description of the entitlement
      */
-    export interface Feature {
-      /**
-       * The feature ID to attach the entitlement to
-       */
-      featureId: string;
-
-      /**
-       * Entitlement behavior (Increment or Override)
-       */
-      behavior?: 'Increment' | 'Override';
+    description?: string;
 
-      /**
-       * Description of the entitlement
-       */
-      description?: string;
+    /**
+     * Override display name for the entitlement
+     */
+    displayNameOverride?: string;
 
-      /**
-       * Override display name for the entitlement
-       */
-      displayNameOverride?: string;
+    /**
+     * Allowed enum values for the feature entitlement
+     */
+    enumValues?: Array<string>;
 
-      /**
-       * Allowed enum values for the feature entitlement
-       */
-      enumValues?: Array<string>;
+    /**
+     * Whether the usage limit is a soft limit
+     */
+    hasSoftLimit?: boolean;
 
-      /**
-       * Whether the usage limit is a soft limit
-       */
-      hasSoftLimit?: boolean;
+    /**
+     * Whether usage is unlimited
+     */
+    hasUnlimitedUsage?: boolean;
 
-      /**
-       * Whether usage is unlimited
-       */
-      hasUnlimitedUsage?: boolean;
+    /**
+     * Widget types where this entitlement is hidden
+     */
+    hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
 
-      /**
-       * Widget types where this entitlement is hidden
-       */
-      hiddenFromWidgets?: Array<'PAYWALL' | 'CUSTOMER_PORTAL' | 'CHECKOUT'>;
+    /**
+     * Whether this is a custom entitlement
+     */
+    isCustom?: boolean;
 
-      /**
-       * Whether this is a custom entitlement
-       */
-      isCustom?: boolean;
+    /**
+     * Whether the entitlement is granted
+     */
+    isGranted?: boolean;
 
-      /**
-       * Whether the entitlement is granted
-       */
-      isGranted?: boolean;
+    /**
+     * Configuration for monthly reset period
+     */
+    monthlyResetPeriodConfiguration?: Feature.MonthlyResetPeriodConfiguration | null;
 
-      /**
-       * Configuration for monthly reset period
-       */
-      monthlyResetPeriodConfiguration?: Feature.MonthlyResetPeriodConfiguration | null;
+    /**
+     * Display order of the entitlement
+     */
+    order?: number;
 
-      /**
-       * Display order of the entitlement
-       */
-      order?: number;
+    /**
+     * Period at which usage resets
+     */
+    resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
 
-      /**
-       * Period at which usage resets
-       */
-      resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
+    /**
+     * Maximum allowed usage for the feature
+     */
+    usageLimit?: number | null;
 
-      /**
-       * Maximum allowed usage for the feature
-       */
-      usageLimit?: number | null;
+    /**
+     * Configuration for weekly reset period
+     */
+    weeklyResetPeriodConfiguration?: Feature.WeeklyResetPeriodConfiguration | null;
 
-      /**
-       * Configuration for weekly reset period
-       */
-      weeklyResetPeriodConfiguration?: Feature.WeeklyResetPeriodConfiguration | null;
+    /**
+     * Configuration for yearly reset period
+     */
+    yearlyResetPeriodConfiguration?: Feature.YearlyResetPeriodConfiguration | null;
+  }
 
+  export namespace Feature {
+    /**
+     * Configuration for monthly reset period
+     */
+    export interface MonthlyResetPeriodConfiguration {
       /**
-       * Configuration for yearly reset period
+       * Reset anchor (SubscriptionStart or StartOfTheMonth)
        */
-      yearlyResetPeriodConfiguration?: Feature.YearlyResetPeriodConfiguration | null;
+      accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
     }
 
-    export namespace Feature {
-      /**
-       * Configuration for monthly reset period
-       */
-      export interface MonthlyResetPeriodConfiguration {
-        /**
-         * Reset anchor (SubscriptionStart or StartOfTheMonth)
-         */
-        accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
-      }
-
+    /**
+     * Configuration for weekly reset period
+     */
+    export interface WeeklyResetPeriodConfiguration {
       /**
-       * Configuration for weekly reset period
+       * Reset anchor (SubscriptionStart or specific day)
        */
-      export interface WeeklyResetPeriodConfiguration {
-        /**
-         * Reset anchor (SubscriptionStart or specific day)
-         */
-        accordingTo:
-          | 'SubscriptionStart'
-          | 'EverySunday'
-          | 'EveryMonday'
-          | 'EveryTuesday'
-          | 'EveryWednesday'
-          | 'EveryThursday'
-          | 'EveryFriday'
-          | 'EverySaturday';
-      }
+      accordingTo:
+        | 'SubscriptionStart'
+        | 'EverySunday'
+        | 'EveryMonday'
+        | 'EveryTuesday'
+        | 'EveryWednesday'
+        | 'EveryThursday'
+        | 'EveryFriday'
+        | 'EverySaturday';
+    }
 
+    /**
+     * Configuration for yearly reset period
+     */
+    export interface YearlyResetPeriodConfiguration {
       /**
-       * Configuration for yearly reset period
+       * Reset anchor (SubscriptionStart)
        */
-      export interface YearlyResetPeriodConfiguration {
-        /**
-         * Reset anchor (SubscriptionStart)
-         */
-        accordingTo: 'SubscriptionStart';
-      }
+      accordingTo: 'SubscriptionStart';
     }
   }
-}
-
-export interface EntitlementUpdateParams {
-  /**
-   * Path param: The plan ID
-   */
-  planId: string;
-
-  /**
-   * Body param: Credit entitlement fields to update
-   */
-  credit?: EntitlementUpdateParams.Credit;
 
   /**
-   * Body param: Feature entitlement fields to update
-   */
-  feature?: EntitlementUpdateParams.Feature;
-}
-
-export namespace EntitlementUpdateParams {
-  /**
-   * Credit entitlement fields to update
+   * Request to create a credit entitlement
    */
   export 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
@@ -827,88 +901,101 @@ export namespace EntitlementUpdateParams {
      */
     order?: number;
   }
+}
 
-  /**
-   * Feature entitlement fields to update
-   */
-  export interface Feature {
+export type EntitlementUpdateParams =
+  | EntitlementUpdateParams.UpdateFeatureEntitlementRequest
+  | EntitlementUpdateParams.UpdateCreditEntitlementRequest;
+
+export declare namespace EntitlementUpdateParams {
+  export interface UpdateFeatureEntitlementRequest {
     /**
-     * Entitlement behavior (Increment or Override)
+     * Path param: The plan ID
+     */
+    planId: 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;
   }
 
-  export namespace Feature {
+  export namespace UpdateFeatureEntitlementRequest {
     /**
      * Configuration for monthly reset period
      */
@@ -947,6 +1034,63 @@ export namespace EntitlementUpdateParams {
       accordingTo: 'SubscriptionStart';
     }
   }
+
+  export interface UpdateCreditEntitlementRequest {
+    /**
+     * Path param: The plan ID
+     */
+    planId: 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 {