@stigg/node-server-sdk - v4.22.1

    Type Alias PackageEntitlementInput

    Package entitlement input

    type PackageEntitlementInput = {
        behavior?: InputMaybe<EntitlementBehavior>;
        dependencyFeatureId?: InputMaybe<Scalars["String"]>;
        description?: InputMaybe<Scalars["String"]>;
        displayNameOverride?: InputMaybe<Scalars["String"]>;
        enumValues?: InputMaybe<Scalars["String"][]>;
        environmentId: Scalars["UUID"];
        featureGroupId?: InputMaybe<Scalars["UUID"]>;
        featureId: Scalars["UUID"];
        hasSoftLimit?: InputMaybe<Scalars["Boolean"]>;
        hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>;
        hiddenFromWidgets?: InputMaybe<WidgetType[]>;
        isCustom?: InputMaybe<Scalars["Boolean"]>;
        isGranted?: InputMaybe<Scalars["Boolean"]>;
        monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
        order?: InputMaybe<Scalars["Float"]>;
        packageId: Scalars["UUID"];
        resetPeriod?: InputMaybe<EntitlementResetPeriod>;
        usageLimit?: InputMaybe<Scalars["Float"]>;
        weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
        yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
    }
    Index

    Properties

    behavior?: InputMaybe<EntitlementBehavior>

    The behavior of the entitlement

    dependencyFeatureId?: InputMaybe<Scalars["String"]>

    The feature ID this entitlement depends on (credit entitlements only). The entitlement value will be calculated as: base amount × dependency feature usage limit

    description?: InputMaybe<Scalars["String"]>

    The description of the entitlement

    displayNameOverride?: InputMaybe<Scalars["String"]>

    The display name override of the entitlement

    enumValues?: InputMaybe<Scalars["String"][]>

    The enum values of the entitlement

    environmentId: Scalars["UUID"]

    The unique identifier for the environment

    featureGroupId?: InputMaybe<Scalars["UUID"]>

    Primary feature group ID (first in the array) associated with this entitlement

    featureId: Scalars["UUID"]

    The unique identifier of the entitlement feature

    hasSoftLimit?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has a soft limit

    hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement has an unlimited usage

    hiddenFromWidgets?: InputMaybe<WidgetType[]>

    Whether the entitlement is hidden from widgets

    isCustom?: InputMaybe<Scalars["Boolean"]>

    Whether the entitlement is a custom entitlement

    isGranted?: InputMaybe<Scalars["Boolean"]>

    Whether entitlement grant is active

    monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>

    The monthly reset period configuration of the entitlement, defined when reset period is monthly

    order?: InputMaybe<Scalars["Float"]>

    The order of the entitlement in the entitlement list

    packageId: Scalars["UUID"]

    The unique identifier of the plan or add-on

    resetPeriod?: InputMaybe<EntitlementResetPeriod>

    The reset period of the entitlement

    usageLimit?: InputMaybe<Scalars["Float"]>

    The usage limit of the entitlement

    weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>

    The weekly reset period configuration of the entitlement, defined when reset period is weekly

    yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>

    The yearly reset period configuration of the entitlement, defined when reset period is yearly

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR