1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-09-19 17:52:45 +02:00

chore: update orval types (#4402)

Includes a lot of openapi updates + some new segment change requests models etc
This commit is contained in:
Thomas Heartman 2023-08-03 15:05:20 +02:00 committed by GitHub
parent 7cab19d9d2
commit dbc7d088f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
220 changed files with 2166 additions and 319 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -4,6 +4,9 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Query parameters used to modify the list of features returned.
*/
export interface AdminFeaturesQuerySchema { export interface AdminFeaturesQuerySchema {
/** Used to filter by tags. For each entry, a TAGTYPE:TAGVALUE is expected */ /** Used to filter by tags. For each entry, a TAGTYPE:TAGVALUE is expected */
tag?: string[]; tag?: string[];

View File

@ -5,6 +5,9 @@
*/ */
import type { ConstraintSchema } from './constraintSchema'; import type { ConstraintSchema } from './constraintSchema';
/**
* A description of a [segment](https://docs.getunleash.io/reference/segments)
*/
export interface AdminSegmentSchema { export interface AdminSegmentSchema {
/** The ID of this segment */ /** The ID of this segment */
id: number; id: number;
@ -18,9 +21,10 @@ export interface AdminSegmentSchema {
usedInFeatures?: number | null; usedInFeatures?: number | null;
/** The number of projects that use this segment */ /** The number of projects that use this segment */
usedInProjects?: number | null; usedInProjects?: number | null;
/** The project the segment belongs to. Only present if the segment is a project-specific segment. */
project?: string | null; project?: string | null;
/** The creator's email or username */ /** The creator's email or username */
createdBy?: string; createdBy?: string | null;
/** When the segment was created */ /** When the segment was created */
createdAt: string; createdAt: string;
} }

View File

@ -3,14 +3,13 @@
* Do not edit manually. * Do not edit manually.
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
import type { AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayloadType } from './advancedPlaygroundEnvironmentFeatureSchemaVariantPayloadType';
/** /**
* An optional payload attached to the variant. * An optional payload attached to the variant.
*/ */
export type AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayload = { export type AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayload = {
/** The format of the payload. */ /** The format of the payload. */
type: AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayloadType; type: string;
/** The payload value stringified. */ /** The payload value stringified. */
value: string; value: string;
}; };

View File

@ -1,18 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The format of the payload.
*/
export type AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayloadType =
typeof AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayloadType[keyof typeof AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayloadType];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AdvancedPlaygroundEnvironmentFeatureSchemaVariantPayloadType = {
json: 'json',
csv: 'csv',
string: 'string',
} as const;

View File

@ -4,6 +4,9 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Data about an application that's connected to Unleash via an SDK.
*/
export interface ApplicationSchema { export interface ApplicationSchema {
/** Name of the application */ /** Name of the application */
appName: string; appName: string;

View File

@ -5,7 +5,10 @@
*/ */
import type { ApplicationSchema } from './applicationSchema'; import type { ApplicationSchema } from './applicationSchema';
/**
* An object containing a list of applications that have connected to Unleash via an SDK.
*/
export interface ApplicationsSchema { export interface ApplicationsSchema {
/** Contains a list of applications that have connected via an SDK */ /** The list of applications that have connected to this Unleash instance. */
applications?: ApplicationSchema[]; applications?: ApplicationSchema[];
} }

View File

@ -4,6 +4,10 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Data used to add a comment to a [change request](https://docs.getunleash.io/reference/change-requests).
*/
export interface ChangeRequestAddCommentSchema { export interface ChangeRequestAddCommentSchema {
/** The content of the comment. */
text: string; text: string;
} }

View File

@ -5,7 +5,12 @@
*/ */
import type { ChangeRequestApprovalSchemaCreatedBy } from './changeRequestApprovalSchemaCreatedBy'; import type { ChangeRequestApprovalSchemaCreatedBy } from './changeRequestApprovalSchemaCreatedBy';
/**
* Information about a [change request](https://docs.getunleash.io/reference/change-requests) approval.
*/
export interface ChangeRequestApprovalSchema { export interface ChangeRequestApprovalSchema {
/** Information about the user who gave this approval. */
createdBy: ChangeRequestApprovalSchemaCreatedBy; createdBy: ChangeRequestApprovalSchemaCreatedBy;
/** When the approval was given. */
createdAt: string; createdAt: string;
} }

View File

@ -4,8 +4,14 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Information about the user who gave this approval.
*/
export type ChangeRequestApprovalSchemaCreatedBy = { export type ChangeRequestApprovalSchemaCreatedBy = {
/** The ID of the user who gave this approval. */
id?: number; id?: number;
/** The approving user's username. */
username?: string; username?: string;
/** The URL where the user's image can be found. */
imageUrl?: string; imageUrl?: string;
}; };

View File

@ -0,0 +1,25 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestChangeSchemaPayload } from './changeRequestChangeSchemaPayload';
import type { ChangeRequestChangeSchemaCreatedBy } from './changeRequestChangeSchemaCreatedBy';
/**
* A change request event, containing info about the type of change and the specific changes.
*/
export interface ChangeRequestChangeSchema {
/** The ID of this change. */
id: number;
/** The kind of action that the change contains information about. */
action: string;
/** A description of the conflict caused by this change. Only present if there are any conflicts. */
conflict?: string;
/** The data required to perform this action. */
payload: ChangeRequestChangeSchemaPayload;
/** The user who created this change. */
createdBy?: ChangeRequestChangeSchemaCreatedBy;
/** When this change was suggested */
createdAt?: string;
}

View File

@ -0,0 +1,15 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The user who created this change.
*/
export type ChangeRequestChangeSchemaCreatedBy = {
/** The user's username. */
username?: string | null;
/** The URL where the user's image can be found. */
imageUrl?: string | null;
};

View File

@ -0,0 +1,17 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestChangeSchemaPayloadOneOf } from './changeRequestChangeSchemaPayloadOneOf';
import type { SetStrategySortOrderSchema } from './setStrategySortOrderSchema';
/**
* The data required to perform this action.
*/
export type ChangeRequestChangeSchemaPayload =
| string
| boolean
| ChangeRequestChangeSchemaPayloadOneOf
| number
| SetStrategySortOrderSchema;

View File

@ -4,4 +4,4 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type ChangeRequestEventSchemaPayloadOneOf = { [key: string]: any }; export type ChangeRequestChangeSchemaPayloadOneOf = { [key: string]: any };

View File

@ -5,9 +5,16 @@
*/ */
import type { ChangeRequestCommentSchemaCreatedBy } from './changeRequestCommentSchemaCreatedBy'; import type { ChangeRequestCommentSchemaCreatedBy } from './changeRequestCommentSchemaCreatedBy';
/**
* A comment belonging to a [change request](https://docs.getunleash.io/reference/change-requests).
*/
export interface ChangeRequestCommentSchema { export interface ChangeRequestCommentSchema {
/** The comment's ID. Unique per change request. */
id?: number; id?: number;
/** The content of the comment. */
text: string; text: string;
/** Information about the user who posted the comment */
createdBy: ChangeRequestCommentSchemaCreatedBy; createdBy: ChangeRequestCommentSchemaCreatedBy;
/** When the comment was made. */
createdAt: string; createdAt: string;
} }

View File

@ -4,7 +4,12 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Information about the user who posted the comment
*/
export type ChangeRequestCommentSchemaCreatedBy = { export type ChangeRequestCommentSchemaCreatedBy = {
/** The user's username. */
username?: string | null; username?: string | null;
/** The URL where the user's image can be found. */
imageUrl?: string | null; imageUrl?: string | null;
}; };

View File

@ -5,4 +5,7 @@
*/ */
import type { ChangeRequestEnvironmentConfigSchema } from './changeRequestEnvironmentConfigSchema'; import type { ChangeRequestEnvironmentConfigSchema } from './changeRequestEnvironmentConfigSchema';
/**
* A list of environment-specific [change request](https://docs.getunleash.io/reference/change-requests) configurations.
*/
export type ChangeRequestConfigSchema = ChangeRequestEnvironmentConfigSchema[]; export type ChangeRequestConfigSchema = ChangeRequestEnvironmentConfigSchema[];

View File

@ -0,0 +1,40 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateFeatureSchemaOneOf } from './changeRequestCreateFeatureSchemaOneOf';
import type { ChangeRequestCreateFeatureSchemaOneOfFour } from './changeRequestCreateFeatureSchemaOneOfFour';
import type { ChangeRequestCreateFeatureSchemaOneOfSix } from './changeRequestCreateFeatureSchemaOneOfSix';
import type { ChangeRequestCreateFeatureSchemaOneOfEight } from './changeRequestCreateFeatureSchemaOneOfEight';
import type { ChangeRequestCreateFeatureSchemaOneOfOneone } from './changeRequestCreateFeatureSchemaOneOfOneone';
import type { ChangeRequestCreateFeatureSchemaOneOfOnefour } from './changeRequestCreateFeatureSchemaOneOfOnefour';
/**
* Data used to create a [change request](https://docs.getunleash.io/reference/change-requests) for a single feature change.
*/
export type ChangeRequestCreateFeatureSchema =
| (ChangeRequestCreateFeatureSchemaOneOf & {
/** The name of the feature that this change applies to. */
feature: string;
})
| (ChangeRequestCreateFeatureSchemaOneOfFour & {
/** The name of the feature that this change applies to. */
feature: string;
})
| (ChangeRequestCreateFeatureSchemaOneOfSix & {
/** The name of the feature that this change applies to. */
feature: string;
})
| (ChangeRequestCreateFeatureSchemaOneOfEight & {
/** The name of the feature that this change applies to. */
feature: string;
})
| (ChangeRequestCreateFeatureSchemaOneOfOneone & {
/** The name of the feature that this change applies to. */
feature: string;
})
| (ChangeRequestCreateFeatureSchemaOneOfOnefour & {
/** The name of the feature that this change applies to. */
feature: string;
});

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateFeatureSchemaOneOfAction } from './changeRequestCreateFeatureSchemaOneOfAction';
import type { ChangeRequestCreateFeatureSchemaOneOfPayload } from './changeRequestCreateFeatureSchemaOneOfPayload';
/**
* Update the enabled state for a feature.
*/
export type ChangeRequestCreateFeatureSchemaOneOf = {
/** The name of this action. */
action: ChangeRequestCreateFeatureSchemaOneOfAction;
payload: ChangeRequestCreateFeatureSchemaOneOfPayload;
};

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The name of this action.
*/
export type ChangeRequestCreateFeatureSchemaOneOfAction =
typeof ChangeRequestCreateFeatureSchemaOneOfAction[keyof typeof ChangeRequestCreateFeatureSchemaOneOfAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateFeatureSchemaOneOfAction = {
updateEnabled: 'updateEnabled',
} as const;

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateFeatureSchemaOneOfEightAction } from './changeRequestCreateFeatureSchemaOneOfEightAction';
import type { ChangeRequestCreateFeatureSchemaOneOfEightPayload } from './changeRequestCreateFeatureSchemaOneOfEightPayload';
/**
* Delete a strategy from this feature.
*/
export type ChangeRequestCreateFeatureSchemaOneOfEight = {
/** The name of this action. */
action: ChangeRequestCreateFeatureSchemaOneOfEightAction;
payload: ChangeRequestCreateFeatureSchemaOneOfEightPayload;
};

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The name of this action.
*/
export type ChangeRequestCreateFeatureSchemaOneOfEightAction =
typeof ChangeRequestCreateFeatureSchemaOneOfEightAction[keyof typeof ChangeRequestCreateFeatureSchemaOneOfEightAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateFeatureSchemaOneOfEightAction = {
deleteStrategy: 'deleteStrategy',
} as const;

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type ChangeRequestCreateFeatureSchemaOneOfEightPayload = {
/** The ID of the strategy to update. */
id: string;
};

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateFeatureSchemaOneOfFourAction } from './changeRequestCreateFeatureSchemaOneOfFourAction';
import type { CreateFeatureStrategySchema } from './createFeatureStrategySchema';
/**
* Add a strategy to the feature
*/
export type ChangeRequestCreateFeatureSchemaOneOfFour = {
/** The name of this action. */
action: ChangeRequestCreateFeatureSchemaOneOfFourAction;
payload: CreateFeatureStrategySchema;
};

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The name of this action.
*/
export type ChangeRequestCreateFeatureSchemaOneOfFourAction =
typeof ChangeRequestCreateFeatureSchemaOneOfFourAction[keyof typeof ChangeRequestCreateFeatureSchemaOneOfFourAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateFeatureSchemaOneOfFourAction = {
addStrategy: 'addStrategy',
} as const;

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateFeatureSchemaOneOfOnefourAction } from './changeRequestCreateFeatureSchemaOneOfOnefourAction';
import type { SetStrategySortOrderSchema } from './setStrategySortOrderSchema';
/**
* Reorder strategies for this feature
*/
export type ChangeRequestCreateFeatureSchemaOneOfOnefour = {
/** The name of this action. */
action: ChangeRequestCreateFeatureSchemaOneOfOnefourAction;
payload: SetStrategySortOrderSchema;
};

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The name of this action.
*/
export type ChangeRequestCreateFeatureSchemaOneOfOnefourAction =
typeof ChangeRequestCreateFeatureSchemaOneOfOnefourAction[keyof typeof ChangeRequestCreateFeatureSchemaOneOfOnefourAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateFeatureSchemaOneOfOnefourAction = {
reorderStrategy: 'reorderStrategy',
} as const;

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateFeatureSchemaOneOfOneoneAction } from './changeRequestCreateFeatureSchemaOneOfOneoneAction';
import type { ChangeRequestCreateFeatureSchemaOneOfOneonePayload } from './changeRequestCreateFeatureSchemaOneOfOneonePayload';
/**
* Update variants for this feature.
*/
export type ChangeRequestCreateFeatureSchemaOneOfOneone = {
/** The name of this action. */
action: ChangeRequestCreateFeatureSchemaOneOfOneoneAction;
payload: ChangeRequestCreateFeatureSchemaOneOfOneonePayload;
};

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The name of this action.
*/
export type ChangeRequestCreateFeatureSchemaOneOfOneoneAction =
typeof ChangeRequestCreateFeatureSchemaOneOfOneoneAction[keyof typeof ChangeRequestCreateFeatureSchemaOneOfOneoneAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateFeatureSchemaOneOfOneoneAction = {
patchVariant: 'patchVariant',
} as const;

View File

@ -5,6 +5,6 @@
*/ */
import type { VariantSchema } from './variantSchema'; import type { VariantSchema } from './variantSchema';
export type ChangeRequestCreateSchemaOneOfOneonePayload = { export type ChangeRequestCreateFeatureSchemaOneOfOneonePayload = {
variants: VariantSchema[]; variants: VariantSchema[];
}; };

View File

@ -4,6 +4,7 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type ChangeRequestCreateSchemaOneOfPayload = { export type ChangeRequestCreateFeatureSchemaOneOfPayload = {
/** The new state of the feature. */
enabled: boolean; enabled: boolean;
}; };

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateFeatureSchemaOneOfSixAction } from './changeRequestCreateFeatureSchemaOneOfSixAction';
import type { UpdateFeatureStrategySchema } from './updateFeatureStrategySchema';
/**
* Update a strategy belonging to this feature.
*/
export type ChangeRequestCreateFeatureSchemaOneOfSix = {
/** The name of this action. */
action: ChangeRequestCreateFeatureSchemaOneOfSixAction;
payload: UpdateFeatureStrategySchema;
};

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The name of this action.
*/
export type ChangeRequestCreateFeatureSchemaOneOfSixAction =
typeof ChangeRequestCreateFeatureSchemaOneOfSixAction[keyof typeof ChangeRequestCreateFeatureSchemaOneOfSixAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateFeatureSchemaOneOfSixAction = {
updateStrategy: 'updateStrategy',
} as const;

View File

@ -3,25 +3,12 @@
* Do not edit manually. * Do not edit manually.
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
import type { ChangeRequestCreateSchemaOneOf } from './changeRequestCreateSchemaOneOf'; import type { ChangeRequestCreateSegmentSchema } from './changeRequestCreateSegmentSchema';
import type { ChangeRequestCreateSchemaOneOfFour } from './changeRequestCreateSchemaOneOfFour'; import type { ChangeRequestCreateFeatureSchema } from './changeRequestCreateFeatureSchema';
import type { ChangeRequestCreateSchemaOneOfSix } from './changeRequestCreateSchemaOneOfSix';
import type { ChangeRequestCreateSchemaOneOfEight } from './changeRequestCreateSchemaOneOfEight';
import type { ChangeRequestCreateSchemaOneOfOneone } from './changeRequestCreateSchemaOneOfOneone';
/**
* Data used to create a [change request](https://docs.getunleash.io/reference/change-requests) for a single feature or segment change.
*/
export type ChangeRequestCreateSchema = export type ChangeRequestCreateSchema =
| (ChangeRequestCreateSchemaOneOf & { | ChangeRequestCreateSegmentSchema
feature: string; | ChangeRequestCreateFeatureSchema;
})
| (ChangeRequestCreateSchemaOneOfFour & {
feature: string;
})
| (ChangeRequestCreateSchemaOneOfSix & {
feature: string;
})
| (ChangeRequestCreateSchemaOneOfEight & {
feature: string;
})
| (ChangeRequestCreateSchemaOneOfOneone & {
feature: string;
});

View File

@ -1,12 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateSchemaOneOfAction } from './changeRequestCreateSchemaOneOfAction';
import type { ChangeRequestCreateSchemaOneOfPayload } from './changeRequestCreateSchemaOneOfPayload';
export type ChangeRequestCreateSchemaOneOf = {
action: ChangeRequestCreateSchemaOneOfAction;
payload: ChangeRequestCreateSchemaOneOfPayload;
};

View File

@ -1,13 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type ChangeRequestCreateSchemaOneOfAction =
typeof ChangeRequestCreateSchemaOneOfAction[keyof typeof ChangeRequestCreateSchemaOneOfAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateSchemaOneOfAction = {
updateEnabled: 'updateEnabled',
} as const;

View File

@ -1,12 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateSchemaOneOfEightAction } from './changeRequestCreateSchemaOneOfEightAction';
import type { ChangeRequestCreateSchemaOneOfEightPayload } from './changeRequestCreateSchemaOneOfEightPayload';
export type ChangeRequestCreateSchemaOneOfEight = {
action: ChangeRequestCreateSchemaOneOfEightAction;
payload: ChangeRequestCreateSchemaOneOfEightPayload;
};

View File

@ -1,13 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type ChangeRequestCreateSchemaOneOfEightAction =
typeof ChangeRequestCreateSchemaOneOfEightAction[keyof typeof ChangeRequestCreateSchemaOneOfEightAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateSchemaOneOfEightAction = {
deleteStrategy: 'deleteStrategy',
} as const;

View File

@ -1,12 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateSchemaOneOfFourAction } from './changeRequestCreateSchemaOneOfFourAction';
import type { CreateFeatureStrategySchema } from './createFeatureStrategySchema';
export type ChangeRequestCreateSchemaOneOfFour = {
action: ChangeRequestCreateSchemaOneOfFourAction;
payload: CreateFeatureStrategySchema;
};

View File

@ -1,13 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type ChangeRequestCreateSchemaOneOfFourAction =
typeof ChangeRequestCreateSchemaOneOfFourAction[keyof typeof ChangeRequestCreateSchemaOneOfFourAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateSchemaOneOfFourAction = {
addStrategy: 'addStrategy',
} as const;

View File

@ -1,12 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateSchemaOneOfOneoneAction } from './changeRequestCreateSchemaOneOfOneoneAction';
import type { ChangeRequestCreateSchemaOneOfOneonePayload } from './changeRequestCreateSchemaOneOfOneonePayload';
export type ChangeRequestCreateSchemaOneOfOneone = {
action: ChangeRequestCreateSchemaOneOfOneoneAction;
payload: ChangeRequestCreateSchemaOneOfOneonePayload;
};

View File

@ -1,13 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type ChangeRequestCreateSchemaOneOfOneoneAction =
typeof ChangeRequestCreateSchemaOneOfOneoneAction[keyof typeof ChangeRequestCreateSchemaOneOfOneoneAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateSchemaOneOfOneoneAction = {
patchVariant: 'patchVariant',
} as const;

View File

@ -1,12 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateSchemaOneOfSixAction } from './changeRequestCreateSchemaOneOfSixAction';
import type { UpdateFeatureStrategySchema } from './updateFeatureStrategySchema';
export type ChangeRequestCreateSchemaOneOfSix = {
action: ChangeRequestCreateSchemaOneOfSixAction;
payload: UpdateFeatureStrategySchema;
};

View File

@ -1,13 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type ChangeRequestCreateSchemaOneOfSixAction =
typeof ChangeRequestCreateSchemaOneOfSixAction[keyof typeof ChangeRequestCreateSchemaOneOfSixAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateSchemaOneOfSixAction = {
updateStrategy: 'updateStrategy',
} as const;

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateSegmentSchemaOneOf } from './changeRequestCreateSegmentSchemaOneOf';
import type { ChangeRequestCreateSegmentSchemaOneOfThree } from './changeRequestCreateSegmentSchemaOneOfThree';
/**
* Data used to create a [change request](https://docs.getunleash.io/reference/change-requests) for a single segment change.
*/
export type ChangeRequestCreateSegmentSchema =
| ChangeRequestCreateSegmentSchemaOneOf
| ChangeRequestCreateSegmentSchemaOneOfThree;

View File

@ -0,0 +1,13 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateSegmentSchemaOneOfAction } from './changeRequestCreateSegmentSchemaOneOfAction';
import type { UpsertSegmentSchema } from './upsertSegmentSchema';
export type ChangeRequestCreateSegmentSchemaOneOf = {
/** The name of this action. */
action: ChangeRequestCreateSegmentSchemaOneOfAction;
payload: UpsertSegmentSchema;
};

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The name of this action.
*/
export type ChangeRequestCreateSegmentSchemaOneOfAction =
typeof ChangeRequestCreateSegmentSchemaOneOfAction[keyof typeof ChangeRequestCreateSegmentSchemaOneOfAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateSegmentSchemaOneOfAction = {
updateSegment: 'updateSegment',
} as const;

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestCreateSegmentSchemaOneOfThreeAction } from './changeRequestCreateSegmentSchemaOneOfThreeAction';
import type { ChangeRequestCreateSegmentSchemaOneOfThreePayload } from './changeRequestCreateSegmentSchemaOneOfThreePayload';
export type ChangeRequestCreateSegmentSchemaOneOfThree = {
/** The name of this action. */
action: ChangeRequestCreateSegmentSchemaOneOfThreeAction;
/** Required data to delete a segment. */
payload: ChangeRequestCreateSegmentSchemaOneOfThreePayload;
};

View File

@ -0,0 +1,16 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The name of this action.
*/
export type ChangeRequestCreateSegmentSchemaOneOfThreeAction =
typeof ChangeRequestCreateSegmentSchemaOneOfThreeAction[keyof typeof ChangeRequestCreateSegmentSchemaOneOfThreeAction];
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ChangeRequestCreateSegmentSchemaOneOfThreeAction = {
deleteSegment: 'deleteSegment',
} as const;

View File

@ -0,0 +1,13 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* Required data to delete a segment.
*/
export type ChangeRequestCreateSegmentSchemaOneOfThreePayload = {
/** The ID of the segment to delete. */
id: number;
};

View File

@ -0,0 +1,18 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestDefaultChangeSchemaPayload } from './changeRequestDefaultChangeSchemaPayload';
/**
* A description of a default change that will be applied with the change request to prevent invalid states.
Default changes are changes that are applied in addition to explicit user-specified changes when a change request is applied. Any default changes are applied in the background and are not a real part of the change request.
*/
export interface ChangeRequestDefaultChangeSchema {
/** The kind of action this is. */
action: string;
/** The necessary data to perform this change. */
payload: ChangeRequestDefaultChangeSchemaPayload;
}

View File

@ -0,0 +1,10 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* The necessary data to perform this change.
*/
export type ChangeRequestDefaultChangeSchemaPayload = { [key: string]: any };

View File

@ -1,11 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestDefaultEventSchemaPayload } from './changeRequestDefaultEventSchemaPayload';
export interface ChangeRequestDefaultEventSchema {
action: string;
payload: ChangeRequestDefaultEventSchemaPayload;
}

View File

@ -4,9 +4,16 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* The [change request](https://docs.getunleash.io/reference/change-requests) configuration for a specific environment.
*/
export interface ChangeRequestEnvironmentConfigSchema { export interface ChangeRequestEnvironmentConfigSchema {
/** The environment that this configuration applies to. */
environment: string; environment: string;
/** The [type of the environment](https://docs.getunleash.io/reference/environments#environment-types) listed in `environment`. */
type: string; type: string;
/** `true` if this environment has change requests enabled, otherwise `false`. */
changeRequestEnabled: boolean; changeRequestEnabled: boolean;
/** The number of approvals that are required for a change request to be fully approved and ready to be applied in this environment. */
requiredApprovals: number | null; requiredApprovals: number | null;
} }

View File

@ -1,17 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestEventSchemaPayload } from './changeRequestEventSchemaPayload';
import type { ChangeRequestEventSchemaCreatedBy } from './changeRequestEventSchemaCreatedBy';
export interface ChangeRequestEventSchema {
id: number;
action: string;
conflict?: string;
payload: ChangeRequestEventSchemaPayload;
updatedBy?: string;
createdBy?: ChangeRequestEventSchemaCreatedBy;
createdAt?: string;
}

View File

@ -1,10 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
export type ChangeRequestEventSchemaCreatedBy = {
username?: string | null;
imageUrl?: string | null;
};

View File

@ -1,12 +0,0 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { ChangeRequestEventSchemaPayloadOneOf } from './changeRequestEventSchemaPayloadOneOf';
export type ChangeRequestEventSchemaPayload =
| string
| boolean
| ChangeRequestEventSchemaPayloadOneOf
| number;

View File

@ -3,13 +3,18 @@
* Do not edit manually. * Do not edit manually.
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
import type { ChangeRequestEventSchema } from './changeRequestEventSchema'; import type { ChangeRequestChangeSchema } from './changeRequestChangeSchema';
import type { ChangeRequestDefaultEventSchema } from './changeRequestDefaultEventSchema'; import type { ChangeRequestDefaultChangeSchema } from './changeRequestDefaultChangeSchema';
/**
* A feature and all its suggested changes.
*/
export interface ChangeRequestFeatureSchema { export interface ChangeRequestFeatureSchema {
/** The name of the feature */
name: string; name: string;
/** A string describing the conflicts related to this change. Only present if there are any concflicts on the feature level. */
conflict?: string; conflict?: string;
/** List of changes inside change request. This list may be empty when listing all change requests for a project. */ /** List of changes inside change request. This list may be empty when listing all change requests for a project. */
changes: ChangeRequestEventSchema[]; changes: ChangeRequestChangeSchema[];
defaultChange?: ChangeRequestDefaultEventSchema; defaultChange?: ChangeRequestDefaultChangeSchema;
} }

View File

@ -5,6 +5,9 @@
*/ */
import type { ChangeRequestCreateSchema } from './changeRequestCreateSchema'; import type { ChangeRequestCreateSchema } from './changeRequestCreateSchema';
/**
* Either a single change or a list of changes to create a change request from.
*/
export type ChangeRequestOneOrManyCreateSchema = export type ChangeRequestOneOrManyCreateSchema =
| ChangeRequestCreateSchema | ChangeRequestCreateSchema
| ChangeRequestCreateSchema[]; | ChangeRequestCreateSchema[];

View File

@ -5,20 +5,37 @@
*/ */
import type { ChangeRequestSchemaState } from './changeRequestSchemaState'; import type { ChangeRequestSchemaState } from './changeRequestSchemaState';
import type { ChangeRequestFeatureSchema } from './changeRequestFeatureSchema'; import type { ChangeRequestFeatureSchema } from './changeRequestFeatureSchema';
import type { ChangeRequestChangeSchema } from './changeRequestChangeSchema';
import type { ChangeRequestApprovalSchema } from './changeRequestApprovalSchema'; import type { ChangeRequestApprovalSchema } from './changeRequestApprovalSchema';
import type { ChangeRequestCommentSchema } from './changeRequestCommentSchema'; import type { ChangeRequestCommentSchema } from './changeRequestCommentSchema';
import type { ChangeRequestSchemaCreatedBy } from './changeRequestSchemaCreatedBy'; import type { ChangeRequestSchemaCreatedBy } from './changeRequestSchemaCreatedBy';
/**
* A [change request](https://docs.getunleash.io/reference/change-requests)
*/
export interface ChangeRequestSchema { export interface ChangeRequestSchema {
/** This change requests's ID. */
id: number; id: number;
/** A title describing the change request's content. */
title?: string; title?: string;
/** The environment in which the changes should be applied. */
environment: string; environment: string;
/** The current state of the change request. */
state: ChangeRequestSchemaState; state: ChangeRequestSchemaState;
/** The minimum number of approvals required before this change request can be applied. */
minApprovals: number; minApprovals: number;
/** The project this change request belongs to. */
project: string; project: string;
/** The list of features and their changes that relate to this change request. */
features: ChangeRequestFeatureSchema[]; features: ChangeRequestFeatureSchema[];
/** The list of segments and their changes that relate to this change request. */
segments: ChangeRequestChangeSchema[];
/** A list of approvals that this change request has received. */
approvals?: ChangeRequestApprovalSchema[]; approvals?: ChangeRequestApprovalSchema[];
/** All comments that have been made on this change request. */
comments?: ChangeRequestCommentSchema[]; comments?: ChangeRequestCommentSchema[];
/** The user who created this change request. */
createdBy: ChangeRequestSchemaCreatedBy; createdBy: ChangeRequestSchemaCreatedBy;
/** When this change request was created. */
createdAt: string; createdAt: string;
} }

View File

@ -4,7 +4,11 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* The user who created this change request.
*/
export type ChangeRequestSchemaCreatedBy = { export type ChangeRequestSchemaCreatedBy = {
username?: string | null; username?: string | null;
/** The URL of the user's profile image. */
imageUrl?: string | null; imageUrl?: string | null;
}; };

View File

@ -4,6 +4,9 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* The current state of the change request.
*/
export type ChangeRequestSchemaState = export type ChangeRequestSchemaState =
typeof ChangeRequestSchemaState[keyof typeof ChangeRequestSchemaState]; typeof ChangeRequestSchemaState[keyof typeof ChangeRequestSchemaState];

View File

@ -5,7 +5,12 @@
*/ */
import type { ChangeRequestStateSchemaState } from './changeRequestStateSchemaState'; import type { ChangeRequestStateSchemaState } from './changeRequestStateSchemaState';
/**
* Data used to update the state of a [change request](https://docs.getunleash.io/reference/change-requests).
*/
export interface ChangeRequestStateSchema { export interface ChangeRequestStateSchema {
/** The new desired state for the change request */
state: ChangeRequestStateSchemaState; state: ChangeRequestStateSchemaState;
/** Any comments accompanying the state changed. Used when sending a draft to review. */
comment?: string; comment?: string;
} }

View File

@ -4,6 +4,9 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* The new desired state for the change request
*/
export type ChangeRequestStateSchemaState = export type ChangeRequestStateSchemaState =
typeof ChangeRequestStateSchemaState[keyof typeof ChangeRequestStateSchemaState]; typeof ChangeRequestStateSchemaState[keyof typeof ChangeRequestStateSchemaState];

View File

@ -4,6 +4,10 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Data used to update a [change request](https://docs.getunleash.io/reference/change-requests)'s title.
*/
export interface ChangeRequestUpdateTitleSchema { export interface ChangeRequestUpdateTitleSchema {
/** The new title to use for this change request. */
title: string; title: string;
} }

View File

@ -5,4 +5,7 @@
*/ */
import type { ChangeRequestSchema } from './changeRequestSchema'; import type { ChangeRequestSchema } from './changeRequestSchema';
/**
* A list of change requests
*/
export type ChangeRequestsSchema = ChangeRequestSchema[]; export type ChangeRequestsSchema = ChangeRequestSchema[];

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -4,6 +4,9 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Data used to clone an environment.
*/
export interface CloneEnvironmentSchema { export interface CloneEnvironmentSchema {
/** The name of the new cloned environment, this cannot be changed later */ /** The name of the new cloned environment, this cannot be changed later */
name: string; name: string;

View File

@ -0,0 +1,22 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { LegalValueSchema } from './legalValueSchema';
/**
* Data used to create a context field configuration.
*/
export interface CreateContextFieldSchema {
/** A description of the context field */
description?: string;
/** `true` if this field should be available for use with [custom stickiness](https://docs.getunleash.io/reference/stickiness#custom-stickiness), otherwise `false` */
stickiness?: boolean;
/** How this context field should be sorted if no other sort order is selected */
sortOrder?: number;
/** A list of allowed values for this context field */
legalValues?: LegalValueSchema[];
/** The name of the context field. */
name: string;
}

View File

@ -4,6 +4,9 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Data used to create a new feature toggle.
*/
export interface CreateFeatureSchema { export interface CreateFeatureSchema {
/** Unique feature name */ /** Unique feature name */
name: string; name: string;

View File

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

View File

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

View File

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

View File

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

View File

@ -0,0 +1,23 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateGroupSchemaUsersItem } from './createGroupSchemaUsersItem';
/**
* A detailed information about a user group
*/
export interface CreateGroupSchema {
/** The name of the group */
name: string;
/** A custom description of the group */
description?: string | null;
/** A list of SSO groups that should map to this Unleash group */
mappingsSSO?: string[];
/** A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role. */
rootRole?: number | null;
/** A list of users belonging to this group */
users?: CreateGroupSchemaUsersItem[];
[key: string]: any;
}

View File

@ -0,0 +1,14 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
import type { CreateGroupSchemaUsersItemUser } from './createGroupSchemaUsersItemUser';
/**
* A minimal user object
*/
export type CreateGroupSchemaUsersItem = {
/** A minimal user object */
user: CreateGroupSchemaUsersItemUser;
};

View File

@ -0,0 +1,13 @@
/**
* Generated by Orval
* Do not edit manually.
* See `gen:api` script in package.json
*/
/**
* A minimal user object
*/
export type CreateGroupSchemaUsersItemUser = {
/** The user id */
id: number;
};

View File

@ -4,9 +4,16 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* Data used to create a user that has been invited to Unleash.
*/
export interface CreateInvitedUserSchema { export interface CreateInvitedUserSchema {
/** The user's username. Must be unique if provided. */
username?: string; username?: string;
/** The invited user's email address */
email: string; email: string;
/** The user's name */
name: string; name: string;
/** The user's password */
password: string; password: string;
} }

View File

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

View File

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

View File

@ -5,10 +5,18 @@
*/ */
import type { CreateProjectSchemaMode } from './createProjectSchemaMode'; import type { CreateProjectSchemaMode } from './createProjectSchemaMode';
/**
* Data used to create a new [project](https://docs.getunleash.io/reference/projects).
*/
export interface CreateProjectSchema { export interface CreateProjectSchema {
/** The project's identifier. */
id: string; id: string;
/** The project's name. */
name: string; name: string;
description?: string; /** The project's description. */
description?: string | null;
/** A limit on the number of features allowed in the project. `null` if no limit. */
featureLimit?: number | null;
/** A mode of the project affecting what actions are possible in this project */ /** A mode of the project affecting what actions are possible in this project */
mode?: CreateProjectSchemaMode; mode?: CreateProjectSchemaMode;
/** A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy */ /** A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy */

View File

@ -4,7 +4,7 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
export type DeleteRole409 = { export type CreateRole401 = {
/** The ID of the error instance */ /** The ID of the error instance */
id?: string; id?: string;
/** The name of the error kind */ /** The name of the error kind */

View File

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

View File

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

View File

@ -6,9 +6,16 @@
import type { CreateRoleWithPermissionsSchemaType } from './createRoleWithPermissionsSchemaType'; import type { CreateRoleWithPermissionsSchemaType } from './createRoleWithPermissionsSchemaType';
import type { CreateRoleWithPermissionsSchemaPermissionsItem } from './createRoleWithPermissionsSchemaPermissionsItem'; import type { CreateRoleWithPermissionsSchemaPermissionsItem } from './createRoleWithPermissionsSchemaPermissionsItem';
/**
* A write model for the custom role and permissions to allow Unleash to decide what actions a role holder is allowed to perform
*/
export interface CreateRoleWithPermissionsSchema { export interface CreateRoleWithPermissionsSchema {
/** The name of the custom role */
name: string; name: string;
/** A more detailed description of the custom role and what use it's intended for */
description?: string; description?: string;
/** A custom role can either be a global/root custom role (applies to all projects) or a project custom role */
type?: CreateRoleWithPermissionsSchemaType; type?: CreateRoleWithPermissionsSchemaType;
/** A list of permissions assigned to this role */
permissions?: CreateRoleWithPermissionsSchemaPermissionsItem[]; permissions?: CreateRoleWithPermissionsSchemaPermissionsItem[];
} }

View File

@ -5,6 +5,8 @@
*/ */
export type CreateRoleWithPermissionsSchemaPermissionsItem = { export type CreateRoleWithPermissionsSchemaPermissionsItem = {
/** The id of the permission */
id: number; id: number;
/** The environments of the permission if the permission is environment specific */
environment?: string; environment?: string;
}; };

View File

@ -4,6 +4,9 @@
* See `gen:api` script in package.json * See `gen:api` script in package.json
*/ */
/**
* A custom role can either be a global/root custom role (applies to all projects) or a project custom role
*/
export type CreateRoleWithPermissionsSchemaType = export type CreateRoleWithPermissionsSchemaType =
typeof CreateRoleWithPermissionsSchemaType[keyof typeof CreateRoleWithPermissionsSchemaType]; typeof CreateRoleWithPermissionsSchemaType[keyof typeof CreateRoleWithPermissionsSchemaType];

View File

@ -3,13 +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 { CreateStrategyVariantSchemaPayloadType } from './createStrategyVariantSchemaPayloadType';
/** /**
* Extra data configured for this variant * Extra data configured for this variant
*/ */
export type CreateStrategyVariantSchemaPayload = { export type CreateStrategyVariantSchemaPayload = {
/** The type of the value. Commonly used types are string, json and csv. */ /** The type of the value. Commonly used types are string, json and csv. */
type: string; type: CreateStrategyVariantSchemaPayloadType;
/** The actual value of payload */ /** The actual value of payload */
value: string; value: string;
}; };

Some files were not shown because too many files have changed in this diff Show More