@leancodepl/kratos/dist/lib/kratos/api.generated/models/Project.d.ts

Headless React components library for building Ory Kratos authentication flows

import { ProjectServices } from './ProjectServices';
import { ProjectCors } from './ProjectCors';
/**
 *
 * @export
 * @interface Project
 */
export interface Project {
    /**
     *
     * @type {ProjectCors}
     * @memberof Project
     */
    cors_admin?: ProjectCors;
    /**
     *
     * @type {ProjectCors}
     * @memberof Project
     */
    cors_public?: ProjectCors;
    /**
     * The environment of the project.
     * prod Production
     * stage Staging
     * dev Development
     * @type {string}
     * @memberof Project
     */
    environment: ProjectEnvironmentEnum;
    /**
     * The project home region.
     *
     * This is used to set where the project data is stored and where the project's endpoints are located.
     * eu-central EUCentral
     * asia-northeast AsiaNorthEast
     * us-east USEast
     * us-west USWest
     * us US
     * global Global
     * @type {string}
     * @memberof Project
     */
    home_region: ProjectHomeRegionEnum;
    /**
     * The project's ID.
     * @type {string}
     * @memberof Project
     */
    readonly id: string;
    /**
     * The name of the project.
     * @type {string}
     * @memberof Project
     */
    name: string;
    /**
     * The configuration revision ID.
     * @type {string}
     * @memberof Project
     */
    readonly revision_id: string;
    /**
     *
     * @type {ProjectServices}
     * @memberof Project
     */
    services: ProjectServices;
    /**
     * The project's slug
     * @type {string}
     * @memberof Project
     */
    readonly slug: string;
    /**
     * The state of the project.
     * running Running
     * halted Halted
     * deleted Deleted
     * @type {string}
     * @memberof Project
     */
    readonly state: ProjectStateEnum;
    /**
     *
     * @type {string}
     * @memberof Project
     */
    workspace_id?: string | null;
}
/**
 * @export
 */
export declare const ProjectEnvironmentEnum: {
    readonly Prod: "prod";
    readonly Stage: "stage";
    readonly Dev: "dev";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ProjectEnvironmentEnum = typeof ProjectEnvironmentEnum[keyof typeof ProjectEnvironmentEnum];
/**
 * @export
 */
export declare const ProjectHomeRegionEnum: {
    readonly EuCentral: "eu-central";
    readonly AsiaNortheast: "asia-northeast";
    readonly UsEast: "us-east";
    readonly UsWest: "us-west";
    readonly Us: "us";
    readonly Global: "global";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ProjectHomeRegionEnum = typeof ProjectHomeRegionEnum[keyof typeof ProjectHomeRegionEnum];
/**
 * @export
 */
export declare const ProjectStateEnum: {
    readonly Running: "running";
    readonly Halted: "halted";
    readonly Deleted: "deleted";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ProjectStateEnum = typeof ProjectStateEnum[keyof typeof ProjectStateEnum];
/**
 * Check if a given object implements the Project interface.
 */
export declare function instanceOfProject(value: object): value is Project;
export declare function ProjectFromJSON(json: any): Project;
export declare function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): Project;
export declare function ProjectToJSON(json: any): Project;
export declare function ProjectToJSONTyped(value?: Omit<Project, 'id' | 'revision_id' | 'slug' | 'state'> | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=Project.d.ts.map