@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
61 lines (60 loc) • 5.45 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.
*/
/**
* Control API consistency guarantees
* @export
* @interface ConsistencyRequestParameters
*/
export interface ConsistencyRequestParameters {
/**
* Read Consistency Level (preview)
*
* The read consistency level determines the consistency guarantee for reads:
*
* strong (slow): The read is guaranteed to return the most recent data committed at the start of the read.
* eventual (very fast): The result will return data that is about 4.8 seconds old.
*
* The default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with
* `ory patch project --replace '/previews/default_read_consistency_level="strong"'`.
*
* Setting the default consistency level to `eventual` may cause regressions in the future as we add consistency
* controls to more APIs. Currently, the following APIs will be affected by this setting:
*
* `GET /admin/identities`
*
* This feature is in preview and only available in Ory Network.
* ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level.
* strong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level.
* eventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps.
* @type {string}
* @memberof ConsistencyRequestParameters
*/
consistency?: ConsistencyRequestParametersConsistencyEnum;
}
/**
* @export
*/
export declare const ConsistencyRequestParametersConsistencyEnum: {
readonly Empty: "";
readonly Strong: "strong";
readonly Eventual: "eventual";
readonly UnknownDefaultOpenApi: "11184809";
};
export type ConsistencyRequestParametersConsistencyEnum = typeof ConsistencyRequestParametersConsistencyEnum[keyof typeof ConsistencyRequestParametersConsistencyEnum];
/**
* Check if a given object implements the ConsistencyRequestParameters interface.
*/
export declare function instanceOfConsistencyRequestParameters(value: object): value is ConsistencyRequestParameters;
export declare function ConsistencyRequestParametersFromJSON(json: any): ConsistencyRequestParameters;
export declare function ConsistencyRequestParametersFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConsistencyRequestParameters;
export declare function ConsistencyRequestParametersToJSON(json: any): ConsistencyRequestParameters;
export declare function ConsistencyRequestParametersToJSONTyped(value?: ConsistencyRequestParameters | null, ignoreDiscriminator?: boolean): any;