1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-05-03 01:18:43 +02:00

chore: generate missing orval types (#5722)

This commit is contained in:
Jaanus Sellin 2023-12-22 12:10:50 +02:00 committed by GitHub
parent fb94138c5c
commit d8a7d76f7b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
32 changed files with 360 additions and 33 deletions

View File

@ -1,14 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { AdminStrategiesSchemaStrategiesItem } from './adminStrategiesSchemaStrategiesItem';
/**
* A collection of strategies belonging to a specified segment.
*/
export interface AdminStrategiesSchema {
/** The list of strategies */
strategies: AdminStrategiesSchemaStrategiesItem[];
}

View File

@ -9,6 +9,8 @@ import type { ChangeRequestScheduleSchemaStatus } from './changeRequestScheduleS
* A schedule for a change request. * A schedule for a change request.
*/ */
export interface ChangeRequestScheduleSchema { export interface ChangeRequestScheduleSchema {
/** The reason the scheduled failed to apply. */
failureReason?: string | null;
/** When this change request is to be applied. */ /** When this change request is to be applied. */
scheduledAt: string; scheduledAt: string;
/** The status of the schedule. */ /** The status of the schedule. */

View File

@ -0,0 +1,20 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestScheduledQueryParamsSchemaFeature } from './changeRequestScheduledQueryParamsSchemaFeature';
import type { ChangeRequestScheduledQueryParamsSchemaStrategyId } from './changeRequestScheduledQueryParamsSchemaStrategyId';
import type { ChangeRequestScheduledQueryParamsSchemaVariantForFlag } from './changeRequestScheduledQueryParamsSchemaVariantForFlag';
/**
* Query parameters used to modify the list of scheduled change requests returned. For each parameter you add, the list will add any scheduled change requests matching that parameter.
*/
export interface ChangeRequestScheduledQueryParamsSchema {
/** The name of one or more feature flags. */
feature?: ChangeRequestScheduledQueryParamsSchemaFeature;
/** One or more strategy IDs. */
strategyId?: ChangeRequestScheduledQueryParamsSchemaStrategyId;
/** One or more features whose variants have been changed in a scheduled change request. This applies to flag-level variants. For changes to strategy variants, use the `strategyId` query parameter with the relevant strategy's ID. */
variantForFlag?: ChangeRequestScheduledQueryParamsSchemaVariantForFlag;
}

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The name of one or more feature flags.
*/
export type ChangeRequestScheduledQueryParamsSchemaFeature = string[] | string;

View File

@ -0,0 +1,12 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* One or more strategy IDs.
*/
export type ChangeRequestScheduledQueryParamsSchemaStrategyId =
| string[]
| string;

View File

@ -0,0 +1,12 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* One or more features whose variants have been changed in a scheduled change request. This applies to flag-level variants. For changes to strategy variants, use the `strategyId` query parameter with the relevant strategy's ID.
*/
export type ChangeRequestScheduledQueryParamsSchemaVariantForFlag =
| string[]
| string;

View File

@ -0,0 +1,12 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ScheduledChangeRequestViewModelSchema } from './scheduledChangeRequestViewModelSchema';
/**
* A list of scheduled change request view models
*/
export type ChangeRequestScheduledResultSchema =
ScheduledChangeRequestViewModelSchema[];

View File

@ -0,0 +1,15 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Describes the properties required to create or update an incoming webhook.
*/
export interface CreateIncomingWebhookSchema {
/** Whether the incoming webhook is currently enabled. If not specified, defaults to true. */
enabled?: boolean;
/** The incoming webhook name. Must be URL-safe. */
name: string;
}

View File

@ -0,0 +1,13 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Describes the properties required to create or update an incoming webhook token.
*/
export interface CreateIncomingWebhookTokenSchema {
/** The incoming webhook token name. */
name: string;
}

View File

@ -39,5 +39,5 @@ export interface CreateUserResponseSchema {
/** The last time this user logged in */ /** The last time this user logged in */
seenAt?: string | null; seenAt?: string | null;
/** A unique username for the user */ /** A unique username for the user */
username?: string; username?: string | null;
} }

View File

@ -16,6 +16,8 @@ export interface EventSchema {
createdAt: string; createdAt: string;
/** Which user created this event */ /** Which user created this event */
createdBy: string; createdBy: string;
/** The is of the user that created this event */
createdByUserId?: number | null;
/** Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable. */ /** Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable. */
data?: EventSchemaData; data?: EventSchemaData;
/** The feature toggle environment the event relates to, if applicable. */ /** The feature toggle environment the event relates to, if applicable. */

View File

@ -148,4 +148,11 @@ export const EventSchemaType = {
'project-environment-added': 'project-environment-added', 'project-environment-added': 'project-environment-added',
'project-environment-removed': 'project-environment-removed', 'project-environment-removed': 'project-environment-removed',
'default-strategy-updated': 'default-strategy-updated', 'default-strategy-updated': 'default-strategy-updated',
'segment-import': 'segment-import',
'incoming-webhook-created': 'incoming-webhook-created',
'incoming-webhook-updated': 'incoming-webhook-updated',
'incoming-webhook-deleted': 'incoming-webhook-deleted',
'incoming-webhook-token-created': 'incoming-webhook-token-created',
'incoming-webhook-token-updated': 'incoming-webhook-token-updated',
'incoming-webhook-token-deleted': 'incoming-webhook-token-deleted',
} as const; } as const;

View File

@ -3,12 +3,14 @@
* Do not edit manually. * Do not edit manually.
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
import type { ExportQuerySchemaOneOf } from './exportQuerySchemaOneOf'; import type { ExportQuerySchemaAnyOf } from './exportQuerySchemaAnyOf';
import type { ExportQuerySchemaOneOfTwo } from './exportQuerySchemaOneOfTwo'; import type { ExportQuerySchemaAnyOfTwo } from './exportQuerySchemaAnyOfTwo';
import type { ExportQuerySchemaAnyOfThree } from './exportQuerySchemaAnyOfThree';
/** /**
* Available query parameters for the [deprecated export/import](https://docs.getunleash.io/reference/deploy/import-export) functionality. * Available query parameters for the [deprecated export/import](https://docs.getunleash.io/reference/deploy/import-export) functionality.
*/ */
export type ExportQuerySchema = export type ExportQuerySchema =
| ExportQuerySchemaOneOf | ExportQuerySchemaAnyOf
| ExportQuerySchemaOneOfTwo; | ExportQuerySchemaAnyOfTwo
| ExportQuerySchemaAnyOfThree;

View File

@ -4,11 +4,11 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type ExportQuerySchemaOneOfTwo = { export type ExportQuerySchemaAnyOf = {
/** Whether to return a downloadable file */ /** Whether to return a downloadable file */
downloadFile?: boolean; downloadFile?: boolean;
/** The environment to export from */ /** The environment to export from */
environment: string; environment: string;
/** Selects features to export by tag. Takes precedence over the features field. */ /** Selects features to export by name. If the list is empty all features are returned. */
tag: string; features: string[];
}; };

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type ExportQuerySchemaAnyOfThree = {
/** Whether to return a downloadable file */
downloadFile?: boolean;
/** The environment to export from */
environment: string;
/** Selects project to export the features from. Used when no tags or features are provided. */
project: string;
};

View File

@ -4,11 +4,11 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type ExportQuerySchemaOneOf = { export type ExportQuerySchemaAnyOfTwo = {
/** Whether to return a downloadable file */ /** Whether to return a downloadable file */
downloadFile?: boolean; downloadFile?: boolean;
/** The environment to export from */ /** The environment to export from */
environment: string; environment: string;
/** Selects features to export by name. */ /** Selects features to export by tag. */
features: string[]; tag: string;
}; };

View File

@ -8,6 +8,8 @@
* Describes a tag applied to a feature * Describes a tag applied to a feature
*/ */
export interface FeatureTagSchema { export interface FeatureTagSchema {
/** The id of the user who created this tag */
createdByUserId?: number | null;
/** The name of the feature this tag is applied to */ /** The name of the feature this tag is applied to */
featureName: string; featureName: string;
/** The [type](https://docs.getunleash.io/reference/tags#tag-types tag types) of the tag */ /** The [type](https://docs.getunleash.io/reference/tags#tag-types tag types) of the tag */
@ -24,6 +26,4 @@ export interface FeatureTagSchema {
* @deprecated * @deprecated
*/ */
value?: string; value?: string;
/** The id of the user who created this tag */
createdByUserId?: number;
} }

View File

@ -0,0 +1,11 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { FeedbackSchema } from './feedbackSchema';
/**
* A list of feedback items.
*/
export type FeedbackListSchema = FeedbackSchema[];

View File

@ -0,0 +1,25 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Schema representing feedback information.
*/
export interface FeedbackSchema {
/** Details aspects of the service or product that could benefit from enhancements or modifications. Aids in pinpointing areas needing attention for improvement. */
areasForImprovement: string;
/** The category of the feedback. */
category: string;
/** The date and time when the feedback was provided. */
createdAt: string;
/** A score indicating the difficulty experienced by the user. */
difficultyScore: number;
/** The unique identifier of the feedback. */
id: number;
/** This field is for users to mention what they liked. */
positive: string;
/** The type of user providing the feedback. */
userType: string;
}

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type GetScheduledChangeRequests404 = {
/** The ID of the error instance */
id?: string;
/** A description of what went wrong. */
message?: string;
/** The name of the error kind */
name?: string;
};

View File

@ -0,0 +1,21 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* An object describing an incoming webhook.
*/
export interface IncomingWebhookSchema {
/** The date and time of when the incoming webhook was created. */
createdAt: string;
/** The ID of the user that created this incoming webhook. */
createdByUserId: number;
/** Whether the incoming webhook is currently enabled. If not specified, defaults to true. */
enabled: boolean;
/** The incoming webhook's ID. Incoming webhook IDs are incrementing integers. In other words, a more recently created incoming webhook will always have a higher ID than an older one. */
id: number;
/** The incoming webhook name. Must be URL-safe. */
name: string;
}

View File

@ -0,0 +1,23 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* An object describing an incoming webhook token.
*/
export interface IncomingWebhookTokenSchema {
/** The date and time of when the incoming webhook token was created. */
createdAt: string;
/** The ID of the user that created this incoming webhook token. */
createdByUserId: number;
/** The incoming webhook token's ID. Incoming webhook token IDs are incrementing integers. In other words, a more recently created incoming webhook token will always have a higher ID than an older one. */
id: number;
/** The incoming webhook ID that this token belongs to. */
incomingWebhookId: number;
/** The incoming webhook token name. */
name: string;
/** The token used for authentication. It is automatically generated by Unleash when the token is created and that is the only time this property is returned. */
token?: string;
}

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { IncomingWebhookTokenSchema } from './incomingWebhookTokenSchema';
/**
* A response model with a list of incoming webhook tokens.
*/
export interface IncomingWebhookTokensSchema {
/** A list of incoming webhook tokens. */
incoming_webhook_tokens: IncomingWebhookTokenSchema[];
}

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { IncomingWebhookSchema } from './incomingWebhookSchema';
/**
* A response model with a list of incoming webhooks.
*/
export interface IncomingWebhooksSchema {
/** A list of incoming webhooks. */
incoming_webhooks: IncomingWebhookSchema[];
}

View File

@ -62,8 +62,6 @@ export * from './adminPermissionsSchemaPermissions';
export * from './adminPermissionsSchemaPermissionsEnvironmentsItem'; export * from './adminPermissionsSchemaPermissionsEnvironmentsItem';
export * from './adminPermissionsSchemaVersion'; export * from './adminPermissionsSchemaVersion';
export * from './adminSegmentSchema'; export * from './adminSegmentSchema';
export * from './adminStrategiesSchema';
export * from './adminStrategiesSchemaStrategiesItem';
export * from './advancedPlaygroundEnvironmentFeatureSchema'; export * from './advancedPlaygroundEnvironmentFeatureSchema';
export * from './advancedPlaygroundEnvironmentFeatureSchemaStrategies'; export * from './advancedPlaygroundEnvironmentFeatureSchemaStrategies';
export * from './advancedPlaygroundEnvironmentFeatureSchemaStrategiesResult'; export * from './advancedPlaygroundEnvironmentFeatureSchemaStrategiesResult';
@ -218,6 +216,11 @@ export * from './changeRequestOneOrManyCreateSchemaOneOfTwothree';
export * from './changeRequestOneOrManyCreateSchemaOneOfTwothreeAction'; export * from './changeRequestOneOrManyCreateSchemaOneOfTwothreeAction';
export * from './changeRequestScheduleSchema'; export * from './changeRequestScheduleSchema';
export * from './changeRequestScheduleSchemaStatus'; export * from './changeRequestScheduleSchemaStatus';
export * from './changeRequestScheduledQueryParamsSchema';
export * from './changeRequestScheduledQueryParamsSchemaFeature';
export * from './changeRequestScheduledQueryParamsSchemaStrategyId';
export * from './changeRequestScheduledQueryParamsSchemaVariantForFlag';
export * from './changeRequestScheduledResultSchema';
export * from './changeRequestSchema'; export * from './changeRequestSchema';
export * from './changeRequestSchemaOneOf'; export * from './changeRequestSchemaOneOf';
export * from './changeRequestSchemaOneOfCreatedBy'; export * from './changeRequestSchemaOneOfCreatedBy';
@ -317,6 +320,8 @@ export * from './createGroup409';
export * from './createGroupSchema'; export * from './createGroupSchema';
export * from './createGroupSchemaUsersItem'; export * from './createGroupSchemaUsersItem';
export * from './createGroupSchemaUsersItemUser'; export * from './createGroupSchemaUsersItemUser';
export * from './createIncomingWebhookSchema';
export * from './createIncomingWebhookTokenSchema';
export * from './createInvitedUserSchema'; export * from './createInvitedUserSchema';
export * from './createPat401'; export * from './createPat401';
export * from './createPat403'; export * from './createPat403';
@ -472,8 +477,9 @@ export * from './eventsSchema';
export * from './eventsSchemaVersion'; export * from './eventsSchemaVersion';
export * from './exportFeatures404'; export * from './exportFeatures404';
export * from './exportQuerySchema'; export * from './exportQuerySchema';
export * from './exportQuerySchemaOneOf'; export * from './exportQuerySchemaAnyOf';
export * from './exportQuerySchemaOneOfTwo'; export * from './exportQuerySchemaAnyOfThree';
export * from './exportQuerySchemaAnyOfTwo';
export * from './exportResultSchema'; export * from './exportResultSchema';
export * from './exportResultSchemaSegmentsItem'; export * from './exportResultSchemaSegmentsItem';
export * from './featureDependenciesSchema'; export * from './featureDependenciesSchema';
@ -500,7 +506,9 @@ export * from './featureUsageSchema';
export * from './featureVariantsSchema'; export * from './featureVariantsSchema';
export * from './featuresSchema'; export * from './featuresSchema';
export * from './feedbackCreateSchema'; export * from './feedbackCreateSchema';
export * from './feedbackListSchema';
export * from './feedbackResponseSchema'; export * from './feedbackResponseSchema';
export * from './feedbackSchema';
export * from './feedbackUpdateSchema'; export * from './feedbackUpdateSchema';
export * from './getAccessOverview401'; export * from './getAccessOverview401';
export * from './getAccessOverview403'; export * from './getAccessOverview403';
@ -623,6 +631,7 @@ export * from './getRoles403';
export * from './getSamlSettings400'; export * from './getSamlSettings400';
export * from './getSamlSettings401'; export * from './getSamlSettings401';
export * from './getSamlSettings403'; export * from './getSamlSettings403';
export * from './getScheduledChangeRequests404';
export * from './getSegment404'; export * from './getSegment404';
export * from './getServiceAccountTokens401'; export * from './getServiceAccountTokens401';
export * from './getServiceAccountTokens403'; export * from './getServiceAccountTokens403';
@ -669,6 +678,10 @@ export * from './importToggles404';
export * from './importTogglesSchema'; export * from './importTogglesSchema';
export * from './importTogglesValidateItemSchema'; export * from './importTogglesValidateItemSchema';
export * from './importTogglesValidateSchema'; export * from './importTogglesValidateSchema';
export * from './incomingWebhookSchema';
export * from './incomingWebhookTokenSchema';
export * from './incomingWebhookTokensSchema';
export * from './incomingWebhooksSchema';
export * from './instanceAdminStatsSchema'; export * from './instanceAdminStatsSchema';
export * from './instanceAdminStatsSchemaActiveUsers'; export * from './instanceAdminStatsSchemaActiveUsers';
export * from './instanceAdminStatsSchemaClientAppsItem'; export * from './instanceAdminStatsSchemaClientAppsItem';
@ -783,6 +796,7 @@ export * from './projectSettingsSchemaMode';
export * from './projectStatsSchema'; export * from './projectStatsSchema';
export * from './projectUsersSchema'; export * from './projectUsersSchema';
export * from './projectsSchema'; export * from './projectsSchema';
export * from './provideFeedbackSchema';
export * from './proxyClientSchema'; export * from './proxyClientSchema';
export * from './proxyClientSchemaStarted'; export * from './proxyClientSchemaStarted';
export * from './proxyFeatureSchema'; export * from './proxyFeatureSchema';
@ -860,6 +874,7 @@ export * from './roleWithVersionSchema';
export * from './rolesWithVersionSchema'; export * from './rolesWithVersionSchema';
export * from './samlSettingsSchema'; export * from './samlSettingsSchema';
export * from './samlSettingsSchemaDefaultRootRole'; export * from './samlSettingsSchemaDefaultRootRole';
export * from './scheduledChangeRequestViewModelSchema';
export * from './sdkContextSchema'; export * from './sdkContextSchema';
export * from './sdkContextSchemaProperties'; export * from './sdkContextSchemaProperties';
export * from './sdkFlatContextSchema'; export * from './sdkFlatContextSchema';
@ -873,6 +888,9 @@ export * from './searchFeaturesSchema';
export * from './searchUsers401'; export * from './searchUsers401';
export * from './searchUsersParams'; export * from './searchUsersParams';
export * from './segmentSchema'; export * from './segmentSchema';
export * from './segmentStrategiesSchema';
export * from './segmentStrategiesSchemaChangeRequestStrategiesItem';
export * from './segmentStrategiesSchemaStrategiesItem';
export * from './segmentsSchema'; export * from './segmentsSchema';
export * from './sendResetPasswordEmail401'; export * from './sendResetPasswordEmail401';
export * from './sendResetPasswordEmail404'; export * from './sendResetPasswordEmail404';

View File

@ -0,0 +1,21 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Schema representing the creation of feedback information.
*/
export interface ProvideFeedbackSchema {
/** Details aspects of the service or product that could benefit from enhancements or modifications. Aids in pinpointing areas needing attention for improvement. */
areasForImprovement?: string;
/** The category of the feedback. */
category: string;
/** A score indicating the difficulty experienced by the user. */
difficultyScore?: number;
/** This field is for users to mention what they liked. */
positive?: string;
/** The type of user providing the feedback. */
userType?: string;
}

View File

@ -0,0 +1,17 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* A change request view model, used in the UI to identify change requests in conflict
*/
export interface ScheduledChangeRequestViewModelSchema {
/** The environment of the change request */
environment: string;
/** The change request id */
id: number;
/** The change request title */
title?: string;
}

View File

@ -148,4 +148,11 @@ export const SearchEventsSchemaType = {
'project-environment-added': 'project-environment-added', 'project-environment-added': 'project-environment-added',
'project-environment-removed': 'project-environment-removed', 'project-environment-removed': 'project-environment-removed',
'default-strategy-updated': 'default-strategy-updated', 'default-strategy-updated': 'default-strategy-updated',
'segment-import': 'segment-import',
'incoming-webhook-created': 'incoming-webhook-created',
'incoming-webhook-updated': 'incoming-webhook-updated',
'incoming-webhook-deleted': 'incoming-webhook-deleted',
'incoming-webhook-token-created': 'incoming-webhook-token-created',
'incoming-webhook-token-updated': 'incoming-webhook-token-updated',
'incoming-webhook-token-deleted': 'incoming-webhook-token-deleted',
} as const; } as const;

View File

@ -0,0 +1,17 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { SegmentStrategiesSchemaChangeRequestStrategiesItem } from './segmentStrategiesSchemaChangeRequestStrategiesItem';
import type { SegmentStrategiesSchemaStrategiesItem } from './segmentStrategiesSchemaStrategiesItem';
/**
* A collection of strategies belonging to a specified segment.
*/
export interface SegmentStrategiesSchema {
/** A list of strategies that use this segment in active change requests. */
changeRequestStrategies?: SegmentStrategiesSchemaChangeRequestStrategiesItem[];
/** The list of strategies */
strategies: SegmentStrategiesSchemaStrategiesItem[];
}

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type SegmentStrategiesSchemaChangeRequestStrategiesItem = {
/** The ID of the environment that the strategy belongs to. */
environment: string;
/** The name of the feature flag that this strategy belongs to. */
featureName: string;
/** The ID of the strategy. Not present on new strategies that haven't been added to the feature flag yet. */
id?: string;
/** The ID of the project that the strategy belongs to. */
projectId: string;
/** The name of the strategy's type. */
strategyName: string;
};

View File

@ -4,7 +4,7 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type AdminStrategiesSchemaStrategiesItem = { export type SegmentStrategiesSchemaStrategiesItem = {
/** The ID of the environment that the strategy belongs to. */ /** The ID of the environment that the strategy belongs to. */
environment: string; environment: string;
/** The name of the feature flag that this strategy belongs to. */ /** The name of the feature flag that this strategy belongs to. */

View File

@ -38,5 +38,5 @@ export interface UserSchema {
/** The last time this user logged in */ /** The last time this user logged in */
seenAt?: string | null; seenAt?: string | null;
/** A unique username for the user */ /** A unique username for the user */
username?: string; username?: string | null;
} }