1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-20 00:08:02 +01:00

chore: generate orval types (#6310)

This commit is contained in:
Mateusz Kwasniewski 2024-02-22 12:50:17 +01:00 committed by GitHub
parent 81ab77cf7c
commit dc214d376a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
21 changed files with 251 additions and 106 deletions

View File

@ -3,24 +3,27 @@
* Do not edit manually. * Do not edit manually.
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
import type { ActionStateSchema } from './actionStateSchema'; import type { ActionEventSchemaExecutionParams } from './actionEventSchemaExecutionParams';
import type { ActionEventSchemaPayload } from './actionEventSchemaPayload'; import type { ActionEventSchemaState } from './actionEventSchemaState';
import type { ActionEventSchemaSource } from './actionEventSchemaSource';
/** /**
* An object describing an action event. * An object describing an action event.
*/ */
export interface ActionEventSchema { export interface ActionEventSchema {
/** The individual action events. */ /** The name of the action to execute */
actions: ActionStateSchema[]; action: string;
/** The date and time of when the observable event was created. */ /** The date and time of when the action was created. */
createdAt: string; createdAt: string;
/** The observable event's ID. Observable event IDs are incrementing integers. In other words, a more recently created observable event will always have a higher ID than an older one. */ /** The id of user that created this action set */
id?: number; createdByUserId: number;
/** The payload of the observable event. */ /** The details of the action event, if any. */
payload?: ActionEventSchemaPayload; details?: string | null;
/** The observable event source type. Should be used along with `sourceId` to uniquely identify the resource that created this observable event. */ /** A map of parameters to pass to the action */
source: ActionEventSchemaSource; executionParams?: ActionEventSchemaExecutionParams;
/** The ID of the source that created this observable event. Should be used along with `source` to uniquely identify the resource that created this observable event. */ /** The id of the action set */
sourceId: number; id: number;
/** The order in which the action should be executed */
sortOrder: number;
/** The state of the action. Can be one of `not started`, `started`, `success`, or `failed`. */
state: ActionEventSchemaState;
} }

View File

@ -7,4 +7,4 @@
/** /**
* A map of parameters to pass to the action * A map of parameters to pass to the action
*/ */
export type ActionStateSchemaExecutionParams = { [key: string]: any }; export type ActionEventSchemaExecutionParams = { [key: string]: any };

View File

@ -1,10 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The payload of the observable event.
*/
export type ActionEventSchemaPayload = { [key: string]: any };

View File

@ -1,16 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The observable event source type. Should be used along with `sourceId` to uniquely identify the resource that created this observable event.
*/
export type ActionEventSchemaSource =
(typeof ActionEventSchemaSource)[keyof typeof ActionEventSchemaSource];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ActionEventSchemaSource = {
'incoming-webhook': 'incoming-webhook',
} as const;

View File

@ -0,0 +1,19 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The state of the action. Can be one of `not started`, `started`, `success`, or `failed`.
*/
export type ActionEventSchemaState =
(typeof ActionEventSchemaState)[keyof typeof ActionEventSchemaState];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ActionEventSchemaState = {
not_started: 'not started',
started: 'started',
success: 'success',
failed: 'failed',
} as const;

View File

@ -1,14 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionEventSchema } from './actionEventSchema';
/**
* A response model with a list of action events.
*/
export interface ActionEventsSchema {
/** A list of action events. */
actionEvents: ActionEventSchema[];
}

View File

@ -0,0 +1,28 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionSetEventSchemaActionSet } from './actionSetEventSchemaActionSet';
import type { ObservableEventSchema } from './observableEventSchema';
import type { ActionSetEventSchemaState } from './actionSetEventSchemaState';
/**
* An object describing an action event.
*/
export interface ActionSetEventSchema {
/** The action set this action set event belongs to, where the individual actions are decorated with the respective action states. */
actionSet: ActionSetEventSchemaActionSet;
/** The ID of the action set that the action set event belongs to. */
actionSetId: number;
/** The date and time of when the action set event was created. In other words, the date and time of when the action set started executing. */
createdAt: string;
/** The action set event's ID. Action set event IDs are incrementing integers. In other words, a more recently created action set event will always have a higher ID than an older one. */
id: number;
/** The observable event that triggered this action set event. */
observableEvent: ObservableEventSchema;
/** The ID of the observable event that triggered this action set event. */
observableEventId: number;
/** The state of the action set event. Can be one of `started`, `success`, or `failed`. */
state: ActionSetEventSchemaState;
}

View File

@ -0,0 +1,31 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionEventSchema } from './actionEventSchema';
import type { ActionSetEventSchemaActionSetMatch } from './actionSetEventSchemaActionSetMatch';
/**
* The action set this action set event belongs to, where the individual actions are decorated with the respective action states.
*/
export type ActionSetEventSchemaActionSet = {
/** The list of actions executed in sequential order when the action set was triggered, decorated with the individual action states. */
actions: ActionEventSchema[];
/** The id of the service account that will execute the action */
actorId: number;
/** The date and time of when the action set was created. */
createdAt: string;
/** The ID of the user that created this action set. */
createdByUserId: number;
/** Whether this action set is enabled or not */
enabled?: boolean;
/** The ID of the action set. */
id: number;
/** Defines a matching rule for the observable event that will trigger the action set */
match: ActionSetEventSchemaActionSetMatch;
/** The name of the action set */
name: string;
/** The project that this action set belongs to. */
project: string;
};

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionSetEventSchemaActionSetMatchPayload } from './actionSetEventSchemaActionSetMatchPayload';
/**
* Defines a matching rule for the observable event that will trigger the action set
*/
export type ActionSetEventSchemaActionSetMatch = {
/** Match the payload of the observable event */
payload: ActionSetEventSchemaActionSetMatchPayload;
/** Match the source of the observable event */
source: string;
/** Match the source id of the observable event */
sourceId: number;
};

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Match the payload of the observable event
*/
export type ActionSetEventSchemaActionSetMatchPayload = { [key: string]: any };

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The state of the action set event. Can be one of `started`, `success`, or `failed`.
*/
export type ActionSetEventSchemaState =
(typeof ActionSetEventSchemaState)[keyof typeof ActionSetEventSchemaState];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ActionSetEventSchemaState = {
started: 'started',
success: 'success',
failed: 'failed',
} as const;

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionSetEventSchema } from './actionSetEventSchema';
/**
* A response model with a list of action set events.
*/
export interface ActionSetEventsSchema {
/** A list of action set events. */
actionSetEvents: ActionSetEventSchema[];
}

View File

@ -1,25 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ActionStateSchemaExecutionParams } from './actionStateSchemaExecutionParams';
import type { ActionStateSchemaState } from './actionStateSchemaState';
/**
* An object describing an action state.
*/
export interface ActionStateSchema {
/** The name of the action to execute */
action: string;
/** The date and time of the action state update. */
createdAt: string;
/** The details of the action state. Only present if the action state is `failed`. */
details?: string | null;
/** A map of parameters to pass to the action */
executionParams: ActionStateSchemaExecutionParams;
/** The order in which the action should be executed */
sortOrder: number;
/** The state of the action. Can be one of `started`, `finished`, or `failed`. */
state: ActionStateSchemaState;
}

View File

@ -1,18 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The state of the action. Can be one of `started`, `finished`, or `failed`.
*/
export type ActionStateSchemaState =
(typeof ActionStateSchemaState)[keyof typeof ActionStateSchemaState];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ActionStateSchemaState = {
started: 'started',
finished: 'finished',
failed: 'failed',
} as const;

View File

@ -0,0 +1,19 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Data about an application environment
*/
export interface ApplicationOverviewEnvironmentSchema {
/** The number of instances of the application environment */
instanceCount: number;
/** The last time the application environment was seen */
lastSeen: string;
/** Name of the application environment */
name: string;
/** SDKs used in the application environment */
sdks: string[];
}

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ApplicationOverviewEnvironmentSchema } from './applicationOverviewEnvironmentSchema';
/**
* Data about an application that's connected to Unleash via an SDK.
*/
export interface ApplicationOverviewSchema {
/** The list of environments the application has been using. */
environments: ApplicationOverviewEnvironmentSchema[];
/** The number of features the application has been using. */
featureCount: number;
/** The list of projects the application has been using. */
projects: string[];
}

View File

@ -10,5 +10,7 @@ import type { ApplicationSchema } from './applicationSchema';
*/ */
export interface ApplicationsSchema { export interface ApplicationsSchema {
/** The list of applications that have connected to this Unleash instance. */ /** The list of applications that have connected to this Unleash instance. */
applications?: ApplicationSchema[]; applications: ApplicationSchema[];
/** The total number of project applications. */
total: number;
} }

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type GetApplicationOverview404 = {
/** 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,28 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type GetApplicationsParams = {
/**
* The search query for the application name
*/
query?: string;
/**
* The number of applications to skip when returning a page. By default it is set to 0.
*/
offset?: string;
/**
* The number of applications to return in a page. By default it is set to 1000.
*/
limit?: string;
/**
* The field to sort the results by. By default it is set to "appName".
*/
sortBy?: string;
/**
* The sort order for the sortBy. By default it is det to "asc".
*/
sortOrder?: string;
};

View File

@ -8,14 +8,16 @@ export * from './_exportFormat';
export * from './_exportParams'; export * from './_exportParams';
export * from './accessOverviewSchema'; export * from './accessOverviewSchema';
export * from './actionEventSchema'; export * from './actionEventSchema';
export * from './actionEventSchemaPayload'; export * from './actionEventSchemaExecutionParams';
export * from './actionEventSchemaSource'; export * from './actionEventSchemaState';
export * from './actionEventsSchema';
export * from './actionSchema'; export * from './actionSchema';
export * from './actionSchemaExecutionParams'; export * from './actionSchemaExecutionParams';
export * from './actionStateSchema'; export * from './actionSetEventSchema';
export * from './actionStateSchemaExecutionParams'; export * from './actionSetEventSchemaActionSet';
export * from './actionStateSchemaState'; export * from './actionSetEventSchemaActionSetMatch';
export * from './actionSetEventSchemaActionSetMatchPayload';
export * from './actionSetEventSchemaState';
export * from './actionSetEventsSchema';
export * from './actionsListSchema'; export * from './actionsListSchema';
export * from './actionsSchema'; export * from './actionsSchema';
export * from './actionsSchemaMatch'; export * from './actionsSchemaMatch';
@ -88,6 +90,8 @@ export * from './advancedPlaygroundResponseSchema';
export * from './apiTokenSchema'; export * from './apiTokenSchema';
export * from './apiTokenSchemaType'; export * from './apiTokenSchemaType';
export * from './apiTokensSchema'; export * from './apiTokensSchema';
export * from './applicationOverviewEnvironmentSchema';
export * from './applicationOverviewSchema';
export * from './applicationSchema'; export * from './applicationSchema';
export * from './applicationUsageSchema'; export * from './applicationUsageSchema';
export * from './applicationsSchema'; export * from './applicationsSchema';
@ -567,6 +571,8 @@ export * from './getAllToggles403';
export * from './getApiTokensByName401'; export * from './getApiTokensByName401';
export * from './getApiTokensByName403'; export * from './getApiTokensByName403';
export * from './getApplication404'; export * from './getApplication404';
export * from './getApplicationOverview404';
export * from './getApplicationsParams';
export * from './getArchivedFeatures401'; export * from './getArchivedFeatures401';
export * from './getArchivedFeatures403'; export * from './getArchivedFeatures403';
export * from './getArchivedFeaturesByProjectId401'; export * from './getArchivedFeaturesByProjectId401';

View File

@ -13,7 +13,7 @@ export interface ObservableEventSchema {
/** The date and time of when the observable event was created. */ /** The date and time of when the observable event was created. */
createdAt: string; createdAt: string;
/** The ID of the incoming webhook token that created this observable event. Only present if the observable event was created by an incoming webhook. */ /** The ID of the incoming webhook token that created this observable event. Only present if the observable event was created by an incoming webhook. */
createdByIncomingWebhookTokenId?: number; createdByIncomingWebhookTokenId?: number | null;
/** The observable event's ID. Observable event IDs are incrementing integers. In other words, a more recently created observable event will always have a higher ID than an older one. */ /** The observable event's ID. Observable event IDs are incrementing integers. In other words, a more recently created observable event will always have a higher ID than an older one. */
id: number; id: number;
/** The payload of the observable event. */ /** The payload of the observable event. */