@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
272 lines (271 loc) • 11.6 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 { AccountExperienceThemeVariables } from './AccountExperienceThemeVariables';
/**
*
* @export
* @interface ProjectBrandingTheme
*/
export interface ProjectBrandingTheme {
/**
* AccentDefaultColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
accent_default_color?: string;
/**
* AccentDisabledColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
accent_disabled_color?: string;
/**
* AccentEmphasisColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
accent_emphasis_color?: string;
/**
* AccentMutedColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
accent_muted_color?: string;
/**
* AccentSubtleColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
accent_subtle_color?: string;
/**
* The Account Experience Theme Variables.
* @type {Array<AccountExperienceThemeVariables>}
* @memberof ProjectBrandingTheme
*/
account_experience_variables?: Array<AccountExperienceThemeVariables>;
/**
* AccountExperienceVariableStylesheet holds a reference to the current stylesheet that can be used in the AX
* @type {string}
* @memberof ProjectBrandingTheme
*/
account_experience_variables_stylesheet?: string;
/**
* BackgroundCanvasColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
background_canvas_color?: string;
/**
* BackgroundSubtleColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
background_subtle_color?: string;
/**
* BackgroundSurfaceColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
background_surface_color?: string;
/**
* BorderDefaultColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
border_default_color?: string;
/**
* The Customization Creation Date.
* @type {Date}
* @memberof ProjectBrandingTheme
*/
readonly created_at: Date;
/**
* ErrorDefaultColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
error_default_color?: string;
/**
* ErrorEmphasisColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
error_emphasis_color?: string;
/**
* ErrorMutedColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
error_muted_color?: string;
/**
* ErrorSubtleColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
error_subtle_color?: string;
/**
* Favicon Type
* The Favicon mime type.
* @type {string}
* @memberof ProjectBrandingTheme
*/
favicon_type?: string;
/**
* Favicon URL
* Favicon can be an https:// or base64:// URL. If the URL is not allowed, the favicon will be stored inside the Ory Network storage bucket.
* @type {string}
* @memberof ProjectBrandingTheme
*/
favicon_url?: string;
/**
* ForegroundDefaultColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
foreground_default_color?: string;
/**
* ForegroundDisabledColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
foreground_disabled_color?: string;
/**
* ForegroundMutedColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
foreground_muted_color?: string;
/**
* ForegroundOnAccentColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
foreground_on_accent_color?: string;
/**
* ForegroundOnDarkColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
foreground_on_dark_color?: string;
/**
* ForegroundOnDisabledColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
foreground_on_disabled_color?: string;
/**
* ForegroundSubtleColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
foreground_subtle_color?: string;
/**
* The customization theme ID.
* @type {string}
* @memberof ProjectBrandingTheme
*/
readonly id: string;
/**
* InputBackgroundColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
input_background_color?: string;
/**
* InputDisabledColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
input_disabled_color?: string;
/**
* InputPlaceholderColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
input_placeholder_color?: string;
/**
* InputTextColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
input_text_color?: string;
/**
* Logo Type
* The Logo mime type.
* @type {string}
* @memberof ProjectBrandingTheme
*/
logo_type?: string;
/**
* Logo URL
* Logo can be an https:// or base64:// URL. If the URL is not allowed, the logo will be stored inside the Ory Network storage bucket.
* @type {string}
* @memberof ProjectBrandingTheme
*/
logo_url?: string;
/**
* The customization theme name.
* @type {string}
* @memberof ProjectBrandingTheme
*/
name: string;
/**
* Primary color is an hsla color value used to derive the other colors from for the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
primary_color?: string;
/**
* The ProjectBranding ID this customization is associated with.
* @type {string}
* @memberof ProjectBrandingTheme
*/
project_branding_id: string;
/**
* Secondary color is a hsla color code used to derive the other colors from for the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
secondary_color?: string;
/**
* SuccessEmphasisColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
success_emphasis_color?: string;
/**
* TextDefaultColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
text_default_color?: string;
/**
* TextDisabledColor is a hex color code used by the Ory Account Experience theme.
* @type {string}
* @memberof ProjectBrandingTheme
*/
text_disabled_color?: string;
/**
* Last Time Branding was Updated.
* @type {Date}
* @memberof ProjectBrandingTheme
*/
readonly updated_at: Date;
}
/**
* Check if a given object implements the ProjectBrandingTheme interface.
*/
export declare function instanceOfProjectBrandingTheme(value: object): value is ProjectBrandingTheme;
export declare function ProjectBrandingThemeFromJSON(json: any): ProjectBrandingTheme;
export declare function ProjectBrandingThemeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectBrandingTheme;
export declare function ProjectBrandingThemeToJSON(json: any): ProjectBrandingTheme;
export declare function ProjectBrandingThemeToJSONTyped(value?: Omit<ProjectBrandingTheme, 'created_at' | 'id' | 'updated_at'> | null, ignoreDiscriminator?: boolean): any;