@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
245 lines (244 loc) • 14.3 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 * as runtime from '../runtime';
import type { CreateWorkspaceApiKeyBody, CreateWorkspaceBody, ListWorkspaceProjects, ListWorkspaces, UpdateWorkspaceBody, Workspace, WorkspaceApiKey } from '../models/index';
export interface CreateWorkspaceRequest {
createWorkspaceBody?: CreateWorkspaceBody;
}
export interface CreateWorkspaceApiKeyRequest {
workspace: string;
createWorkspaceApiKeyBody?: CreateWorkspaceApiKeyBody;
}
export interface DeleteWorkspaceApiKeyRequest {
workspace: string;
tokenId: string;
}
export interface GetWorkspaceRequest {
workspace: string;
}
export interface ListWorkspaceApiKeysRequest {
workspace: string;
}
export interface ListWorkspaceProjectsRequest {
workspace: string;
}
export interface ListWorkspacesRequest {
pageSize?: number;
pageToken?: string;
}
export interface UpdateWorkspaceRequest {
workspace: string;
updateWorkspaceBody?: UpdateWorkspaceBody;
}
/**
* WorkspaceApi - interface
*
* @export
* @interface WorkspaceApiInterface
*/
export interface WorkspaceApiInterface {
/**
*
* @summary Create a new workspace
* @param {CreateWorkspaceBody} [createWorkspaceBody]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceApiInterface
*/
createWorkspaceRaw(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Workspace>>;
/**
* Create a new workspace
*/
createWorkspace(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
/**
* Create an API key for a workspace.
* @summary Create workspace API key
* @param {string} workspace The Workspace ID
* @param {CreateWorkspaceApiKeyBody} [createWorkspaceApiKeyBody]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceApiInterface
*/
createWorkspaceApiKeyRaw(requestParameters: CreateWorkspaceApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkspaceApiKey>>;
/**
* Create an API key for a workspace.
* Create workspace API key
*/
createWorkspaceApiKey(requestParameters: CreateWorkspaceApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkspaceApiKey>;
/**
* Deletes an API key and immediately removes it.
* @summary Delete workspace API key
* @param {string} workspace The Workspace ID or Workspace slug
* @param {string} tokenId The Token ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceApiInterface
*/
deleteWorkspaceApiKeyRaw(requestParameters: DeleteWorkspaceApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Deletes an API key and immediately removes it.
* Delete workspace API key
*/
deleteWorkspaceApiKey(requestParameters: DeleteWorkspaceApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Any workspace member can access this endpoint.
* @summary Get a workspace
* @param {string} workspace
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceApiInterface
*/
getWorkspaceRaw(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Workspace>>;
/**
* Any workspace member can access this endpoint.
* Get a workspace
*/
getWorkspace(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
/**
* A list of all the workspace\'s API keys.
* @summary List a workspace\'s API keys
* @param {string} workspace The Workspace ID or Workspace slug
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceApiInterface
*/
listWorkspaceApiKeysRaw(requestParameters: ListWorkspaceApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WorkspaceApiKey>>>;
/**
* A list of all the workspace\'s API keys.
* List a workspace\'s API keys
*/
listWorkspaceApiKeys(requestParameters: ListWorkspaceApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WorkspaceApiKey>>;
/**
* Any workspace member can access this endpoint.
* @summary List all projects of a workspace
* @param {string} workspace
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceApiInterface
*/
listWorkspaceProjectsRaw(requestParameters: ListWorkspaceProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWorkspaceProjects>>;
/**
* Any workspace member can access this endpoint.
* List all projects of a workspace
*/
listWorkspaceProjects(requestParameters: ListWorkspaceProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWorkspaceProjects>;
/**
*
* @summary List workspaces the user is a member of
* @param {number} [pageSize] Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
* @param {string} [pageToken] Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceApiInterface
*/
listWorkspacesRaw(requestParameters: ListWorkspacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWorkspaces>>;
/**
* List workspaces the user is a member of
*/
listWorkspaces(requestParameters: ListWorkspacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWorkspaces>;
/**
* Workspace members with the role `OWNER` can access this endpoint.
* @summary Update an workspace
* @param {string} workspace
* @param {UpdateWorkspaceBody} [updateWorkspaceBody]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceApiInterface
*/
updateWorkspaceRaw(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Workspace>>;
/**
* Workspace members with the role `OWNER` can access this endpoint.
* Update an workspace
*/
updateWorkspace(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
}
/**
*
*/
export declare class WorkspaceApi extends runtime.BaseAPI implements WorkspaceApiInterface {
/**
* Create a new workspace
*/
createWorkspaceRaw(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Workspace>>;
/**
* Create a new workspace
*/
createWorkspace(requestParameters?: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
/**
* Create an API key for a workspace.
* Create workspace API key
*/
createWorkspaceApiKeyRaw(requestParameters: CreateWorkspaceApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkspaceApiKey>>;
/**
* Create an API key for a workspace.
* Create workspace API key
*/
createWorkspaceApiKey(requestParameters: CreateWorkspaceApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkspaceApiKey>;
/**
* Deletes an API key and immediately removes it.
* Delete workspace API key
*/
deleteWorkspaceApiKeyRaw(requestParameters: DeleteWorkspaceApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Deletes an API key and immediately removes it.
* Delete workspace API key
*/
deleteWorkspaceApiKey(requestParameters: DeleteWorkspaceApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Any workspace member can access this endpoint.
* Get a workspace
*/
getWorkspaceRaw(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Workspace>>;
/**
* Any workspace member can access this endpoint.
* Get a workspace
*/
getWorkspace(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
/**
* A list of all the workspace\'s API keys.
* List a workspace\'s API keys
*/
listWorkspaceApiKeysRaw(requestParameters: ListWorkspaceApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WorkspaceApiKey>>>;
/**
* A list of all the workspace\'s API keys.
* List a workspace\'s API keys
*/
listWorkspaceApiKeys(requestParameters: ListWorkspaceApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WorkspaceApiKey>>;
/**
* Any workspace member can access this endpoint.
* List all projects of a workspace
*/
listWorkspaceProjectsRaw(requestParameters: ListWorkspaceProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWorkspaceProjects>>;
/**
* Any workspace member can access this endpoint.
* List all projects of a workspace
*/
listWorkspaceProjects(requestParameters: ListWorkspaceProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWorkspaceProjects>;
/**
* List workspaces the user is a member of
*/
listWorkspacesRaw(requestParameters: ListWorkspacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWorkspaces>>;
/**
* List workspaces the user is a member of
*/
listWorkspaces(requestParameters?: ListWorkspacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWorkspaces>;
/**
* Workspace members with the role `OWNER` can access this endpoint.
* Update an workspace
*/
updateWorkspaceRaw(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Workspace>>;
/**
* Workspace members with the role `OWNER` can access this endpoint.
* Update an workspace
*/
updateWorkspace(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
}