@reflag/rest-api-sdk 0.0.1

package/dist/types/generated/types.gen.d.ts

@@ -0,0 +1,996 @@
+/**
+ * App identifier
+ */
+export type AppId = string;
+/**
+ * Optional fields that can be included when requesting the app basic information
+ */
+export type AppHeaderWithExpansionsOptionalFields = 'environments' | 'stages' | 'segments';
+/**
+ * Organization identifier
+ */
+export type OrgId = string;
+/**
+ * Sort order applied to the sorting column
+ */
+export type SortOrder = 'asc' | 'desc';
+/**
+ * The column to sort by
+ */
+export type EnvironmentHeaderSortByColumn = 'name' | 'order';
+/**
+ * Environment identifier
+ */
+export type EnvId = string;
+/**
+ * Unique flag key
+ */
+export type FlagKey = string;
+/**
+ * Update the explicit value of multiple flags for a given audience
+ */
+export type BulkUpdateFlagSpecificTargetsSchema = {
+    /**
+     * The list of updates to make to the flags' targeting
+     */
+    updates: Array<UpdateFlagSpecificTargets>;
+    /**
+     * Whether to send notifications about the change to configured integration (eg. Slack, Linear, etc). Defaults to true.
+     */
+    notifications?: boolean;
+    /**
+     * The description of the change recorded in the change history
+     */
+    changeDescription?: string;
+};
+/**
+ * Update the explicit value of the flag for a given audience (null means to remove the flag from the audience).
+ */
+export type UpdateFlagSpecificTargets = {
+    flagKey: FlagKey;
+    /**
+     * The value of the flag for the given audience (null means to remove the flag from the audience).
+     */
+    value: 'true' | true | null;
+    companyId?: CompanyId;
+    userId?: UserId;
+};
+/**
+ * Company ID within your application
+ */
+export type CompanyId = string;
+/**
+ * User ID within your application
+ */
+export type UserId = string;
+/**
+ * Request body for updating flags for an entity
+ */
+export type UpdateEntityFlagsBody = {
+    /**
+     * List of flag updates to apply
+     */
+    updates: Array<EntityFlagUpdate>;
+    /**
+     * Description of the change for audit history
+     */
+    changeDescription?: string;
+    /**
+     * Whether to send notifications about the change (default: true)
+     */
+    notifications?: boolean;
+};
+/**
+ * Update for a single flag's specific targeting
+ */
+export type EntityFlagUpdate = {
+    flagKey: FlagKey;
+    /**
+     * Set to true to add specific targeting, or null to remove it
+     */
+    value: true | null;
+};
+/**
+ * App information with possible additional expansions
+ */
+export type AppHeaderWithExpansions = {
+    org: OrgHeader;
+    id: AppId;
+    /**
+     * App name
+     */
+    name: string;
+    /**
+     * Whether the app is a demo app
+     */
+    demo: boolean;
+    flagKeyFormat: FlagKeyFormat;
+    /**
+     * Environments within the app (if expanded)
+     */
+    environments?: Array<EnvironmentHeader>;
+    /**
+     * Stages within the app (if expanded)
+     */
+    stages?: Array<StageHeader>;
+    /**
+     * Segments within the app (if expanded)
+     */
+    segments?: Array<SegmentHeader>;
+};
+/**
+ * Organization's basic information
+ */
+export type OrgHeader = {
+    id: OrgId;
+    /**
+     * Organization name
+     */
+    name: string;
+};
+/**
+ * The enforced key format when creating flags
+ */
+export type FlagKeyFormat = 'custom' | 'pascalCase' | 'camelCase' | 'snakeCaseUpper' | 'snakeCaseLower' | 'kebabCaseUpper' | 'kebabCaseLower';
+/**
+ * Basic environment information
+ */
+export type EnvironmentHeader = {
+    id: EnvId;
+    /**
+     * Environment name
+     */
+    name: string;
+    /**
+     * Whether the environment is a production environment
+     */
+    isProduction: boolean;
+    /**
+     * Environment order in the app (zero-indexed)
+     */
+    order: number;
+};
+/**
+ * Stage's basic information
+ */
+export type StageHeader = {
+    id: StageId;
+    /**
+     * Stage name
+     */
+    name: string;
+    /**
+     * Stage color (HTML color name or hex code)
+     */
+    color: string;
+    /**
+     * Flags currently in this stage
+     */
+    assignedFlagCount: number;
+    /**
+     * Stage order
+     */
+    order: number;
+};
+/**
+ * Stage identifier
+ */
+export type StageId = string;
+/**
+ * Segment's basic information
+ */
+export type SegmentHeader = {
+    id: SegmentId;
+    /**
+     * Segment name
+     */
+    name: string;
+    type: SegmentType;
+};
+/**
+ * Segment identifier
+ */
+export type SegmentId = string;
+/**
+ * Segment type
+ */
+export type SegmentType = 'all' | 'custom';
+/**
+ * The error response, including individual issues, if applicable
+ */
+export type ErrorResponse = {
+    /**
+     * The error
+     */
+    error: {
+        /**
+         * Error code
+         */
+        code: 'invalid_request' | 'not_found' | 'not_possible' | 'not_allowed' | 'not_available' | 'unknown_error' | 'unauthorized' | 'unauthenticated';
+        /**
+         * Human readable error message
+         */
+        message: string;
+    };
+    /**
+     * Individual validation issues, if applicable
+     */
+    issues?: {
+        [key: string]: Array<string>;
+    };
+};
+/**
+ * Collection of App information with possible additional expansions
+ */
+export type AppHeaderWithExpansionsCollection = {
+    /**
+     * The individual items in the collection
+     */
+    data: Array<AppHeaderWithExpansions>;
+};
+/**
+ * Collection of Basic environment information with sorting options
+ */
+export type EnvironmentHeaderSortableCollection = {
+    /**
+     * The individual items in the collection
+     */
+    data: Array<EnvironmentHeader>;
+    sortOrder: SortOrder;
+    sortBy: EnvironmentHeaderSortByColumn;
+};
+/**
+ * Environment details
+ */
+export type EnvironmentDetails = {
+    id: EnvId;
+    /**
+     * Environment name
+     */
+    name: string;
+    /**
+     * Whether the environment is a production environment
+     */
+    isProduction: boolean;
+    /**
+     * Environment order in the app (zero-indexed)
+     */
+    order: number;
+    /**
+     * SDK access details
+     */
+    sdkAccess: {
+        /**
+         * Publishable key
+         */
+        publishableKey: string;
+        /**
+         * Secret key
+         */
+        secretKey: string;
+    };
+    /**
+     * Environment-specific auto feedback survey configuration
+     */
+    autoFeedbackSurveys: {
+        /**
+         * Snooze period in seconds
+         */
+        snoozePeriodSeconds: number;
+    };
+    /**
+     * Environment-specific integration configuration
+     */
+    integrations: {
+        /**
+         * Default Slack configuration for the environment
+         */
+        slack?: {
+            channel: InheritableSlackChannel;
+        };
+    };
+};
+/**
+ * Slack channel or inherit
+ */
+export type InheritableSlackChannel = SlackChannel | 'inherit';
+/**
+ * Slack channel
+ */
+export type SlackChannel = {
+    id: SlackChannelId;
+    name: SlackChannelName;
+};
+/**
+ * Slack channel identifier
+ */
+export type SlackChannelId = string;
+/**
+ * Slack channel name
+ */
+export type SlackChannelName = string;
+/**
+ * Collection response containing flags
+ */
+export type FlagHeaderCollection = {
+    /**
+     * Page of the collection of flags
+     */
+    data: Array<FlagHeader>;
+    /**
+     * Total number of flags in collection
+     */
+    totalCount: number;
+    /**
+     * Page size
+     */
+    pageSize: number;
+    /**
+     * Page index
+     */
+    pageIndex: number;
+    /**
+     * Sort by
+     */
+    sortBy: 'name' | 'key' | 'stage' | 'autoFeedbackSurveysEnabled' | 'createdAt' | 'environmentStatus' | 'owner' | 'lastCheck' | 'lastTrack' | 'stale' | 'archivingChecks';
+    /**
+     * Sort order
+     */
+    sortOrder: SortOrder;
+};
+/**
+ * Basic flag information
+ */
+export type FlagHeader = {
+    /**
+     * Flag ID
+     */
+    id: string;
+    key: FlagKey;
+    /**
+     * Flag name
+     */
+    name: string;
+    /**
+     * Flag description
+     */
+    description?: string;
+    stage?: StageHeader;
+    owner?: ReflagUserHeader;
+    /**
+     * Whether the flag is archived
+     */
+    archived: boolean;
+    /**
+     * Whether the flag is stale
+     */
+    stale: boolean;
+    /**
+     * Whether the flag is permanent
+     */
+    permanent: boolean;
+    /**
+     * Timestamp when the flag was created
+     */
+    createdAt?: string;
+    /**
+     * Timestamp when the flag was last checked
+     */
+    lastCheckAt?: string;
+    /**
+     * Timestamp when the flag was last tracked
+     */
+    lastTrackAt?: string;
+};
+/**
+ * Reflag user's basic information
+ */
+export type ReflagUserHeader = {
+    id: ReflagUserId;
+    /**
+     * User's name
+     */
+    name: string;
+    /**
+     * User's email
+     */
+    email: string;
+    /**
+     * User's avatar URL
+     */
+    avatarUrl?: string;
+};
+/**
+ * Reflag user identifier
+ */
+export type ReflagUserId = string;
+/**
+ * Flag targeting information and its audience
+ */
+export type FlagTargeting = {
+    flagKey: FlagKey;
+    version: FlagVersion;
+    /**
+     * Last time the targeting was updated
+     */
+    updatedAt: string;
+    /**
+     * The flag targeting for each value
+     */
+    specificTargets: {
+        [key: string]: FlagValueTargeting;
+    };
+};
+/**
+ * Flag targeting version
+ */
+export type FlagVersion = number;
+/**
+ * The value of the flag served to the audience.
+ */
+export type FlagValue = 'true';
+/**
+ * Flag targeting value and its audience
+ */
+export type FlagValueTargeting = {
+    /**
+     * Companies that were explicitly given the value
+     */
+    companyIds: Array<CompanyId>;
+    /**
+     * Users that were explicitly given the value
+     */
+    userIds: Array<UserId>;
+};
+/**
+ * Collection response containing flags' targeting information
+ */
+export type FlagTargetingCollection = {
+    /**
+     * Collection of flags' targeting information
+     */
+    data: Array<FlagTargeting>;
+};
+/**
+ * Response containing flags for an entity
+ */
+export type EntityFlagsResponse = {
+    /**
+     * List of flags with their enabled status
+     */
+    data: Array<EntityFlag>;
+    /**
+     * Total number of flags
+     */
+    totalCount: number;
+    /**
+     * Page size
+     */
+    pageSize: number;
+    /**
+     * Page index
+     */
+    pageIndex: number;
+};
+/**
+ * Flag information with enabled status for an entity
+ */
+export type EntityFlag = {
+    /**
+     * Flag ID
+     */
+    id: string;
+    key: FlagKey;
+    /**
+     * Flag name
+     */
+    name: string;
+    /**
+     * Whether the flag is enabled for this entity
+     */
+    value: boolean;
+    /**
+     * Value if directly added via specific targets, null if not specifically targeted
+     */
+    specificallyTargetedValue: boolean | null;
+    /**
+     * First time the entity was exposed to this flag
+     */
+    firstExposureAt: string | null;
+    /**
+     * Last time the entity was exposed to this flag
+     */
+    lastExposureAt: string | null;
+    /**
+     * Last time the flag was checked for this entity
+     */
+    lastCheckAt: string | null;
+    /**
+     * Number of times the entity was exposed to this flag
+     */
+    exposureCount: number;
+    /**
+     * First time a track event was recorded for this flag
+     */
+    firstTrackAt: string | null;
+    /**
+     * Last time a track event was recorded for this flag
+     */
+    lastTrackAt: string | null;
+    /**
+     * Number of track events for this flag
+     */
+    trackCount: number;
+};
+export type GetAppData = {
+    body?: never;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+    };
+    query?: {
+        expand?: Array<AppHeaderWithExpansionsOptionalFields>;
+    };
+    url: '/apps/{appId}';
+};
+export type GetAppErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type GetAppError = GetAppErrors[keyof GetAppErrors];
+export type GetAppResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: AppHeaderWithExpansions;
+};
+export type GetAppResponse = GetAppResponses[keyof GetAppResponses];
+export type ListAppsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        orgId?: OrgId;
+        expand?: Array<AppHeaderWithExpansionsOptionalFields>;
+    };
+    url: '/apps';
+};
+export type ListAppsErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type ListAppsError = ListAppsErrors[keyof ListAppsErrors];
+export type ListAppsResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: AppHeaderWithExpansionsCollection;
+};
+export type ListAppsResponse = ListAppsResponses[keyof ListAppsResponses];
+export type ListEnvironmentsData = {
+    body?: never;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+    };
+    query?: {
+        /**
+         * Sort order applied to the sorting column
+         */
+        sortOrder?: SortOrder;
+        /**
+         * The column to sort by
+         */
+        sortBy?: EnvironmentHeaderSortByColumn;
+    };
+    url: '/apps/{appId}/environments';
+};
+export type ListEnvironmentsErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type ListEnvironmentsError = ListEnvironmentsErrors[keyof ListEnvironmentsErrors];
+export type ListEnvironmentsResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: EnvironmentHeaderSortableCollection;
+};
+export type ListEnvironmentsResponse = ListEnvironmentsResponses[keyof ListEnvironmentsResponses];
+export type GetEnvironmentData = {
+    body?: never;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+        /**
+         * Environment identifier
+         */
+        envId: EnvId;
+    };
+    query?: never;
+    url: '/apps/{appId}/environments/{envId}';
+};
+export type GetEnvironmentErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type GetEnvironmentError = GetEnvironmentErrors[keyof GetEnvironmentErrors];
+export type GetEnvironmentResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: EnvironmentDetails;
+};
+export type GetEnvironmentResponse = GetEnvironmentResponses[keyof GetEnvironmentResponses];
+export type ListFlagsData = {
+    body?: never;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+    };
+    query?: never;
+    url: '/apps/{appId}/flags';
+};
+export type ListFlagsErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type ListFlagsError = ListFlagsErrors[keyof ListFlagsErrors];
+export type ListFlagsResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: FlagHeaderCollection;
+};
+export type ListFlagsResponse = ListFlagsResponses[keyof ListFlagsResponses];
+export type GetFlagTargetingData = {
+    body?: never;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+        /**
+         * Unique flag key
+         */
+        flagKey: FlagKey;
+        /**
+         * Environment identifier
+         */
+        envId: EnvId;
+    };
+    query?: never;
+    url: '/apps/{appId}/flags/{flagKey}/targeting/{envId}';
+};
+export type GetFlagTargetingErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type GetFlagTargetingError = GetFlagTargetingErrors[keyof GetFlagTargetingErrors];
+export type GetFlagTargetingResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: FlagTargeting;
+};
+export type GetFlagTargetingResponse = GetFlagTargetingResponses[keyof GetFlagTargetingResponses];
+export type UpdateBulkFlagSpecificTargetsData = {
+    body?: BulkUpdateFlagSpecificTargetsSchema;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+        /**
+         * Environment identifier
+         */
+        envId: EnvId;
+    };
+    query?: never;
+    url: '/apps/{appId}/flags/specific-targets/{envId}';
+};
+export type UpdateBulkFlagSpecificTargetsErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type UpdateBulkFlagSpecificTargetsError = UpdateBulkFlagSpecificTargetsErrors[keyof UpdateBulkFlagSpecificTargetsErrors];
+export type UpdateBulkFlagSpecificTargetsResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: FlagTargetingCollection;
+};
+export type UpdateBulkFlagSpecificTargetsResponse = UpdateBulkFlagSpecificTargetsResponses[keyof UpdateBulkFlagSpecificTargetsResponses];
+export type GetCompanyFlagsData = {
+    body?: never;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+        /**
+         * Company ID within your application
+         */
+        companyId: CompanyId;
+    };
+    query: {
+        /**
+         * Environment ID to evaluate targeting for
+         */
+        envId: string;
+    };
+    url: '/apps/{appId}/companies/{companyId}/flags';
+};
+export type GetCompanyFlagsErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type GetCompanyFlagsError = GetCompanyFlagsErrors[keyof GetCompanyFlagsErrors];
+export type GetCompanyFlagsResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: EntityFlagsResponse;
+};
+export type GetCompanyFlagsResponse = GetCompanyFlagsResponses[keyof GetCompanyFlagsResponses];
+export type UpdateCompanyFlagsData = {
+    body?: UpdateEntityFlagsBody;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+        /**
+         * Company ID within your application
+         */
+        companyId: CompanyId;
+    };
+    query: {
+        /**
+         * Environment ID to evaluate targeting for
+         */
+        envId: string;
+    };
+    url: '/apps/{appId}/companies/{companyId}/flags';
+};
+export type UpdateCompanyFlagsErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type UpdateCompanyFlagsError = UpdateCompanyFlagsErrors[keyof UpdateCompanyFlagsErrors];
+export type UpdateCompanyFlagsResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: EntityFlagsResponse;
+};
+export type UpdateCompanyFlagsResponse = UpdateCompanyFlagsResponses[keyof UpdateCompanyFlagsResponses];
+export type GetUserFlagsData = {
+    body?: never;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+        /**
+         * User ID within your application
+         */
+        userId: UserId;
+    };
+    query: {
+        /**
+         * Environment ID to evaluate targeting for
+         */
+        envId: string;
+    };
+    url: '/apps/{appId}/users/{userId}/flags';
+};
+export type GetUserFlagsErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type GetUserFlagsError = GetUserFlagsErrors[keyof GetUserFlagsErrors];
+export type GetUserFlagsResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: EntityFlagsResponse;
+};
+export type GetUserFlagsResponse = GetUserFlagsResponses[keyof GetUserFlagsResponses];
+export type UpdateUserFlagsData = {
+    body?: UpdateEntityFlagsBody;
+    path: {
+        /**
+         * App identifier
+         */
+        appId: AppId;
+        /**
+         * User ID within your application
+         */
+        userId: UserId;
+    };
+    query: {
+        /**
+         * Environment ID to evaluate targeting for
+         */
+        envId: string;
+    };
+    url: '/apps/{appId}/users/{userId}/flags';
+};
+export type UpdateUserFlagsErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse;
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Requested resource, or its parent, not found
+     */
+    404: ErrorResponse;
+};
+export type UpdateUserFlagsError = UpdateUserFlagsErrors[keyof UpdateUserFlagsErrors];
+export type UpdateUserFlagsResponses = {
+    /**
+     * Requested resource retrieved successfully
+     */
+    200: EntityFlagsResponse;
+};
+export type UpdateUserFlagsResponse = UpdateUserFlagsResponses[keyof UpdateUserFlagsResponses];
+export type ClientOptions = {
+    baseUrl: 'https://app.reflag.com/api' | (string & {});
+};
+//# sourceMappingURL=types.gen.d.ts.map