@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
142 lines (141 loc) • 6.28 kB
TypeScript
/**
* Ory APIs
* # Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) |
*
* The version of the OpenAPI document: v1.20.10
* Contact: support@ory.sh
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { ProjectServices } from './ProjectServices';
import type { 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;