@fulltag/kinde-mgmt-sdk
Version:
Automatically generated SDK for the Kinde Mgmt API
1,528 lines (1,492 loc) • 351 kB
text/typescript
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
declare const BASE_PATH: string;
interface ConfigurationParameters {
basePath?: string;
fetchApi?: FetchAPI;
middleware?: Middleware[];
queryParamsStringify?: (params: HTTPQuery) => string;
username?: string;
password?: string;
apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
headers?: HTTPHeaders;
credentials?: RequestCredentials;
}
declare class Configuration {
private configuration;
constructor(configuration?: ConfigurationParameters);
set config(configuration: Configuration);
get basePath(): string;
get fetchApi(): FetchAPI | undefined;
get middleware(): Middleware[];
get queryParamsStringify(): (params: HTTPQuery) => string;
get username(): string | undefined;
get password(): string | undefined;
get apiKey(): ((name: string) => string | Promise<string>) | undefined;
get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
get headers(): HTTPHeaders | undefined;
get credentials(): RequestCredentials | undefined;
}
declare const DefaultConfig: Configuration;
/**
* This is the base class for all generated API classes.
*/
declare class BaseAPI {
protected configuration: Configuration;
private static readonly jsonRegex;
private middleware;
constructor(configuration?: Configuration);
withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
protected isJsonMime(mime: string | null | undefined): boolean;
protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
private createFetchParams;
private fetchApi;
/**
* Create a shallow clone of `this` by constructing a new instance
* and then shallow cloning data members.
*/
private clone;
}
declare class ResponseError extends Error {
response: Response;
name: "ResponseError";
constructor(response: Response, msg?: string);
}
declare class FetchError extends Error {
cause: Error;
name: "FetchError";
constructor(cause: Error, msg?: string);
}
declare class RequiredError extends Error {
field: string;
name: "RequiredError";
constructor(field: string, msg?: string);
}
declare const COLLECTION_FORMATS: {
csv: string;
ssv: string;
tsv: string;
pipes: string;
};
type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
type Json = any;
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
type HTTPHeaders = {
[key: string]: string;
};
type HTTPQuery = {
[key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
};
type HTTPBody = Json | FormData | URLSearchParams;
type HTTPRequestInit = {
headers?: HTTPHeaders;
method: HTTPMethod;
credentials?: RequestCredentials;
body?: HTTPBody;
};
type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
type InitOverrideFunction = (requestContext: {
init: HTTPRequestInit;
context: RequestOpts;
}) => Promise<RequestInit>;
interface FetchParams {
url: string;
init: RequestInit;
}
interface RequestOpts {
path: string;
method: HTTPMethod;
headers: HTTPHeaders;
query?: HTTPQuery;
body?: HTTPBody;
}
declare function querystring(params: HTTPQuery, prefix?: string): string;
declare function mapValues(data: any, fn: (item: any) => any): {};
declare function canConsumeForm(consumes: Consume[]): boolean;
interface Consume {
contentType: string;
}
interface RequestContext {
fetch: FetchAPI;
url: string;
init: RequestInit;
}
interface ResponseContext {
fetch: FetchAPI;
url: string;
init: RequestInit;
response: Response;
}
interface ErrorContext {
fetch: FetchAPI;
url: string;
init: RequestInit;
error: unknown;
response?: Response;
}
interface Middleware {
pre?(context: RequestContext): Promise<FetchParams | void>;
post?(context: ResponseContext): Promise<Response | void>;
onError?(context: ErrorContext): Promise<Response | void>;
}
interface ApiResponse<T> {
raw: Response;
value(): Promise<T>;
}
interface ResponseTransformer<T> {
(json: any): T;
}
declare class JSONApiResponse<T> {
raw: Response;
private transformer;
constructor(raw: Response, transformer?: ResponseTransformer<T>);
value(): Promise<T>;
}
declare class VoidApiResponse {
raw: Response;
constructor(raw: Response);
value(): Promise<void>;
}
declare class BlobApiResponse {
raw: Response;
constructor(raw: Response);
value(): Promise<Blob>;
}
declare class TextApiResponse {
raw: Response;
constructor(raw: Response);
value(): Promise<string>;
}
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface AddAPIsRequest
*/
interface AddAPIsRequest {
/**
* The name of the API. (1-64 characters).
* @type {string}
* @memberof AddAPIsRequest
*/
name: string;
/**
* A unique identifier for the API - commonly the URL. This value will be used as the `audience` parameter in authorization claims. (1-64 characters)
* @type {string}
* @memberof AddAPIsRequest
*/
audience: string;
}
/**
* Check if a given object implements the AddAPIsRequest interface.
*/
declare function instanceOfAddAPIsRequest(value: object): value is AddAPIsRequest;
declare function AddAPIsRequestFromJSON(json: any): AddAPIsRequest;
declare function AddAPIsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddAPIsRequest;
declare function AddAPIsRequestToJSON(json: any): AddAPIsRequest;
declare function AddAPIsRequestToJSONTyped(value?: AddAPIsRequest | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface AddOrganizationUsersRequestUsersInner
*/
interface AddOrganizationUsersRequestUsersInner {
/**
* The users id.
* @type {string}
* @memberof AddOrganizationUsersRequestUsersInner
*/
id?: string;
/**
* Role keys to assign to the user.
* @type {Array<string>}
* @memberof AddOrganizationUsersRequestUsersInner
*/
roles?: Array<string>;
/**
* Permission keys to assign to the user.
* @type {Array<string>}
* @memberof AddOrganizationUsersRequestUsersInner
*/
permissions?: Array<string>;
}
/**
* Check if a given object implements the AddOrganizationUsersRequestUsersInner interface.
*/
declare function instanceOfAddOrganizationUsersRequestUsersInner(value: object): value is AddOrganizationUsersRequestUsersInner;
declare function AddOrganizationUsersRequestUsersInnerFromJSON(json: any): AddOrganizationUsersRequestUsersInner;
declare function AddOrganizationUsersRequestUsersInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddOrganizationUsersRequestUsersInner;
declare function AddOrganizationUsersRequestUsersInnerToJSON(json: any): AddOrganizationUsersRequestUsersInner;
declare function AddOrganizationUsersRequestUsersInnerToJSONTyped(value?: AddOrganizationUsersRequestUsersInner | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface AddOrganizationUsersRequest
*/
interface AddOrganizationUsersRequest {
/**
* Users to be added to the organization.
* @type {Array<AddOrganizationUsersRequestUsersInner>}
* @memberof AddOrganizationUsersRequest
*/
users?: Array<AddOrganizationUsersRequestUsersInner>;
}
/**
* Check if a given object implements the AddOrganizationUsersRequest interface.
*/
declare function instanceOfAddOrganizationUsersRequest(value: object): value is AddOrganizationUsersRequest;
declare function AddOrganizationUsersRequestFromJSON(json: any): AddOrganizationUsersRequest;
declare function AddOrganizationUsersRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddOrganizationUsersRequest;
declare function AddOrganizationUsersRequestToJSON(json: any): AddOrganizationUsersRequest;
declare function AddOrganizationUsersRequestToJSONTyped(value?: AddOrganizationUsersRequest | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface AddOrganizationUsersResponse
*/
interface AddOrganizationUsersResponse {
/**
* Response code.
* @type {string}
* @memberof AddOrganizationUsersResponse
*/
code?: string;
/**
* Response message.
* @type {string}
* @memberof AddOrganizationUsersResponse
*/
message?: string;
/**
*
* @type {Array<string>}
* @memberof AddOrganizationUsersResponse
*/
usersAdded?: Array<string>;
}
/**
* Check if a given object implements the AddOrganizationUsersResponse interface.
*/
declare function instanceOfAddOrganizationUsersResponse(value: object): value is AddOrganizationUsersResponse;
declare function AddOrganizationUsersResponseFromJSON(json: any): AddOrganizationUsersResponse;
declare function AddOrganizationUsersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddOrganizationUsersResponse;
declare function AddOrganizationUsersResponseToJSON(json: any): AddOrganizationUsersResponse;
declare function AddOrganizationUsersResponseToJSONTyped(value?: AddOrganizationUsersResponse | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface ApiResult
*/
interface ApiResult {
/**
* The result of the api operation.
* @type {string}
* @memberof ApiResult
*/
result?: string;
}
/**
* Check if a given object implements the ApiResult interface.
*/
declare function instanceOfApiResult(value: object): value is ApiResult;
declare function ApiResultFromJSON(json: any): ApiResult;
declare function ApiResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiResult;
declare function ApiResultToJSON(json: any): ApiResult;
declare function ApiResultToJSONTyped(value?: ApiResult | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface Applications
*/
interface Applications {
/**
*
* @type {string}
* @memberof Applications
*/
id?: string;
/**
*
* @type {string}
* @memberof Applications
*/
name?: string;
/**
*
* @type {string}
* @memberof Applications
*/
type?: string;
}
/**
* Check if a given object implements the Applications interface.
*/
declare function instanceOfApplications(value: object): value is Applications;
declare function ApplicationsFromJSON(json: any): Applications;
declare function ApplicationsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Applications;
declare function ApplicationsToJSON(json: any): Applications;
declare function ApplicationsToJSONTyped(value?: Applications | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface AuthorizeAppApiResponse
*/
interface AuthorizeAppApiResponse {
/**
*
* @type {string}
* @memberof AuthorizeAppApiResponse
*/
message?: string;
/**
*
* @type {string}
* @memberof AuthorizeAppApiResponse
*/
code?: string;
/**
*
* @type {Array<string>}
* @memberof AuthorizeAppApiResponse
*/
applicationsDisconnected?: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AuthorizeAppApiResponse
*/
applicationsConnected?: Array<string>;
}
/**
* Check if a given object implements the AuthorizeAppApiResponse interface.
*/
declare function instanceOfAuthorizeAppApiResponse(value: object): value is AuthorizeAppApiResponse;
declare function AuthorizeAppApiResponseFromJSON(json: any): AuthorizeAppApiResponse;
declare function AuthorizeAppApiResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthorizeAppApiResponse;
declare function AuthorizeAppApiResponseToJSON(json: any): AuthorizeAppApiResponse;
declare function AuthorizeAppApiResponseToJSONTyped(value?: AuthorizeAppApiResponse | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface Category
*/
interface Category {
/**
*
* @type {string}
* @memberof Category
*/
id?: string;
/**
*
* @type {string}
* @memberof Category
*/
name?: string;
}
/**
* Check if a given object implements the Category interface.
*/
declare function instanceOfCategory(value: object): value is Category;
declare function CategoryFromJSON(json: any): Category;
declare function CategoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): Category;
declare function CategoryToJSON(json: any): Category;
declare function CategoryToJSONTyped(value?: Category | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface ConnectedAppsAccessToken
*/
interface ConnectedAppsAccessToken {
/**
* The access token to access a third-party provider.
* @type {string}
* @memberof ConnectedAppsAccessToken
*/
accessToken?: string;
/**
* The date and time that the access token expires.
* @type {string}
* @memberof ConnectedAppsAccessToken
*/
accessTokenExpiry?: string;
}
/**
* Check if a given object implements the ConnectedAppsAccessToken interface.
*/
declare function instanceOfConnectedAppsAccessToken(value: object): value is ConnectedAppsAccessToken;
declare function ConnectedAppsAccessTokenFromJSON(json: any): ConnectedAppsAccessToken;
declare function ConnectedAppsAccessTokenFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectedAppsAccessToken;
declare function ConnectedAppsAccessTokenToJSON(json: any): ConnectedAppsAccessToken;
declare function ConnectedAppsAccessTokenToJSONTyped(value?: ConnectedAppsAccessToken | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface ConnectedAppsAuthUrl
*/
interface ConnectedAppsAuthUrl {
/**
* A URL that is used to authenticate an end-user against a connected app.
* @type {string}
* @memberof ConnectedAppsAuthUrl
*/
url?: string;
/**
* A unique identifier for the login session.
* @type {string}
* @memberof ConnectedAppsAuthUrl
*/
sessionId?: string;
}
/**
* Check if a given object implements the ConnectedAppsAuthUrl interface.
*/
declare function instanceOfConnectedAppsAuthUrl(value: object): value is ConnectedAppsAuthUrl;
declare function ConnectedAppsAuthUrlFromJSON(json: any): ConnectedAppsAuthUrl;
declare function ConnectedAppsAuthUrlFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectedAppsAuthUrl;
declare function ConnectedAppsAuthUrlToJSON(json: any): ConnectedAppsAuthUrl;
declare function ConnectedAppsAuthUrlToJSONTyped(value?: ConnectedAppsAuthUrl | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface Connection
*/
interface Connection {
/**
*
* @type {string}
* @memberof Connection
*/
id?: string;
/**
*
* @type {string}
* @memberof Connection
*/
name?: string;
/**
*
* @type {string}
* @memberof Connection
*/
displayName?: string;
/**
*
* @type {string}
* @memberof Connection
*/
strategy?: string;
}
/**
* Check if a given object implements the Connection interface.
*/
declare function instanceOfConnection(value: object): value is Connection;
declare function ConnectionFromJSON(json: any): Connection;
declare function ConnectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Connection;
declare function ConnectionToJSON(json: any): Connection;
declare function ConnectionToJSONTyped(value?: Connection | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateApisResponseApi
*/
interface CreateApisResponseApi {
/**
* The unique ID for the API.
* @type {string}
* @memberof CreateApisResponseApi
*/
id?: string;
}
/**
* Check if a given object implements the CreateApisResponseApi interface.
*/
declare function instanceOfCreateApisResponseApi(value: object): value is CreateApisResponseApi;
declare function CreateApisResponseApiFromJSON(json: any): CreateApisResponseApi;
declare function CreateApisResponseApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApisResponseApi;
declare function CreateApisResponseApiToJSON(json: any): CreateApisResponseApi;
declare function CreateApisResponseApiToJSONTyped(value?: CreateApisResponseApi | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateApisResponse
*/
interface CreateApisResponse {
/**
* A Kinde generated message.
* @type {string}
* @memberof CreateApisResponse
*/
message?: string;
/**
* A Kinde generated status code.
* @type {string}
* @memberof CreateApisResponse
*/
code?: string;
/**
*
* @type {CreateApisResponseApi}
* @memberof CreateApisResponse
*/
api?: CreateApisResponseApi;
}
/**
* Check if a given object implements the CreateApisResponse interface.
*/
declare function instanceOfCreateApisResponse(value: object): value is CreateApisResponse;
declare function CreateApisResponseFromJSON(json: any): CreateApisResponse;
declare function CreateApisResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApisResponse;
declare function CreateApisResponseToJSON(json: any): CreateApisResponse;
declare function CreateApisResponseToJSONTyped(value?: CreateApisResponse | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateApplicationRequest
*/
interface CreateApplicationRequest {
/**
* The application's name.
* @type {string}
* @memberof CreateApplicationRequest
*/
name: string;
/**
* The application's type. Use `reg` for regular server rendered applications, `spa` for single-page applications, and `m2m` for machine-to-machine applications.
* @type {string}
* @memberof CreateApplicationRequest
*/
type: CreateApplicationRequestTypeEnum;
}
/**
* @export
*/
declare const CreateApplicationRequestTypeEnum: {
readonly Reg: "reg";
readonly Spa: "spa";
readonly M2m: "m2m";
};
type CreateApplicationRequestTypeEnum = typeof CreateApplicationRequestTypeEnum[keyof typeof CreateApplicationRequestTypeEnum];
/**
* Check if a given object implements the CreateApplicationRequest interface.
*/
declare function instanceOfCreateApplicationRequest(value: object): value is CreateApplicationRequest;
declare function CreateApplicationRequestFromJSON(json: any): CreateApplicationRequest;
declare function CreateApplicationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApplicationRequest;
declare function CreateApplicationRequestToJSON(json: any): CreateApplicationRequest;
declare function CreateApplicationRequestToJSONTyped(value?: CreateApplicationRequest | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateApplicationResponseApplication
*/
interface CreateApplicationResponseApplication {
/**
* The application's identifier.
* @type {string}
* @memberof CreateApplicationResponseApplication
*/
id?: string;
/**
* The application's client id.
* @type {string}
* @memberof CreateApplicationResponseApplication
*/
clientId?: string;
/**
* The application's client secret.
* @type {string}
* @memberof CreateApplicationResponseApplication
*/
clientSecret?: string;
}
/**
* Check if a given object implements the CreateApplicationResponseApplication interface.
*/
declare function instanceOfCreateApplicationResponseApplication(value: object): value is CreateApplicationResponseApplication;
declare function CreateApplicationResponseApplicationFromJSON(json: any): CreateApplicationResponseApplication;
declare function CreateApplicationResponseApplicationFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApplicationResponseApplication;
declare function CreateApplicationResponseApplicationToJSON(json: any): CreateApplicationResponseApplication;
declare function CreateApplicationResponseApplicationToJSONTyped(value?: CreateApplicationResponseApplication | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateApplicationResponse
*/
interface CreateApplicationResponse {
/**
* Response code.
* @type {string}
* @memberof CreateApplicationResponse
*/
code?: string;
/**
* Response message.
* @type {string}
* @memberof CreateApplicationResponse
*/
message?: string;
/**
*
* @type {CreateApplicationResponseApplication}
* @memberof CreateApplicationResponse
*/
application?: CreateApplicationResponseApplication;
}
/**
* Check if a given object implements the CreateApplicationResponse interface.
*/
declare function instanceOfCreateApplicationResponse(value: object): value is CreateApplicationResponse;
declare function CreateApplicationResponseFromJSON(json: any): CreateApplicationResponse;
declare function CreateApplicationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApplicationResponse;
declare function CreateApplicationResponseToJSON(json: any): CreateApplicationResponse;
declare function CreateApplicationResponseToJSONTyped(value?: CreateApplicationResponse | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateCategoryRequest
*/
interface CreateCategoryRequest {
/**
* The name of the category.
* @type {string}
* @memberof CreateCategoryRequest
*/
name: string;
/**
* The context that the category applies to.
* @type {string}
* @memberof CreateCategoryRequest
*/
context: CreateCategoryRequestContextEnum;
}
/**
* @export
*/
declare const CreateCategoryRequestContextEnum: {
readonly Org: "org";
readonly Usr: "usr";
};
type CreateCategoryRequestContextEnum = typeof CreateCategoryRequestContextEnum[keyof typeof CreateCategoryRequestContextEnum];
/**
* Check if a given object implements the CreateCategoryRequest interface.
*/
declare function instanceOfCreateCategoryRequest(value: object): value is CreateCategoryRequest;
declare function CreateCategoryRequestFromJSON(json: any): CreateCategoryRequest;
declare function CreateCategoryRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCategoryRequest;
declare function CreateCategoryRequestToJSON(json: any): CreateCategoryRequest;
declare function CreateCategoryRequestToJSONTyped(value?: CreateCategoryRequest | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateCategoryResponseCategory
*/
interface CreateCategoryResponseCategory {
/**
* The category's ID.
* @type {string}
* @memberof CreateCategoryResponseCategory
*/
id?: string;
}
/**
* Check if a given object implements the CreateCategoryResponseCategory interface.
*/
declare function instanceOfCreateCategoryResponseCategory(value: object): value is CreateCategoryResponseCategory;
declare function CreateCategoryResponseCategoryFromJSON(json: any): CreateCategoryResponseCategory;
declare function CreateCategoryResponseCategoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCategoryResponseCategory;
declare function CreateCategoryResponseCategoryToJSON(json: any): CreateCategoryResponseCategory;
declare function CreateCategoryResponseCategoryToJSONTyped(value?: CreateCategoryResponseCategory | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateCategoryResponse
*/
interface CreateCategoryResponse {
/**
*
* @type {string}
* @memberof CreateCategoryResponse
*/
message?: string;
/**
*
* @type {string}
* @memberof CreateCategoryResponse
*/
code?: string;
/**
*
* @type {CreateCategoryResponseCategory}
* @memberof CreateCategoryResponse
*/
category?: CreateCategoryResponseCategory;
}
/**
* Check if a given object implements the CreateCategoryResponse interface.
*/
declare function instanceOfCreateCategoryResponse(value: object): value is CreateCategoryResponse;
declare function CreateCategoryResponseFromJSON(json: any): CreateCategoryResponse;
declare function CreateCategoryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCategoryResponse;
declare function CreateCategoryResponseToJSON(json: any): CreateCategoryResponse;
declare function CreateCategoryResponseToJSONTyped(value?: CreateCategoryResponse | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateConnectionRequest
*/
interface CreateConnectionRequest {
/**
* The internal name of the connection.
* @type {string}
* @memberof CreateConnectionRequest
*/
name: string;
/**
* The public facing name of the connection.
* @type {string}
* @memberof CreateConnectionRequest
*/
displayName: string;
/**
* The identity provider identifier for the connection.
* @type {string}
* @memberof CreateConnectionRequest
*/
strategy: CreateConnectionRequestStrategyEnum;
/**
* Client IDs of applications in which this connection is to be enabled.
* @type {Array<string>}
* @memberof CreateConnectionRequest
*/
enabledApplications?: Array<string>;
/**
* The connection's options (varies by strategy).
* @type {object}
* @memberof CreateConnectionRequest
*/
options?: object;
}
/**
* @export
*/
declare const CreateConnectionRequestStrategyEnum: {
readonly Oauth2apple: "oauth2:apple";
readonly Oauth2azureAd: "oauth2:azure_ad";
readonly Oauth2bitbucket: "oauth2:bitbucket";
readonly Oauth2discord: "oauth2:discord";
readonly Oauth2facebook: "oauth2:facebook";
readonly Oauth2github: "oauth2:github";
readonly Oauth2gitlab: "oauth2:gitlab";
readonly Oauth2google: "oauth2:google";
readonly Oauth2linkedin: "oauth2:linkedin";
readonly Oauth2microsoft: "oauth2:microsoft";
readonly Oauth2patreon: "oauth2:patreon";
readonly Oauth2slack: "oauth2:slack";
readonly Oauth2stripe: "oauth2:stripe";
readonly Oauth2twitch: "oauth2:twitch";
readonly Oauth2twitter: "oauth2:twitter";
readonly Oauth2xero: "oauth2:xero";
readonly Samlcustom: "saml:custom";
readonly WsfedazureAd: "wsfed:azure_ad";
};
type CreateConnectionRequestStrategyEnum = typeof CreateConnectionRequestStrategyEnum[keyof typeof CreateConnectionRequestStrategyEnum];
/**
* Check if a given object implements the CreateConnectionRequest interface.
*/
declare function instanceOfCreateConnectionRequest(value: object): value is CreateConnectionRequest;
declare function CreateConnectionRequestFromJSON(json: any): CreateConnectionRequest;
declare function CreateConnectionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateConnectionRequest;
declare function CreateConnectionRequestToJSON(json: any): CreateConnectionRequest;
declare function CreateConnectionRequestToJSONTyped(value?: CreateConnectionRequest | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateConnectionResponseConnection
*/
interface CreateConnectionResponseConnection {
/**
* The connection's ID.
* @type {string}
* @memberof CreateConnectionResponseConnection
*/
id?: string;
}
/**
* Check if a given object implements the CreateConnectionResponseConnection interface.
*/
declare function instanceOfCreateConnectionResponseConnection(value: object): value is CreateConnectionResponseConnection;
declare function CreateConnectionResponseConnectionFromJSON(json: any): CreateConnectionResponseConnection;
declare function CreateConnectionResponseConnectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateConnectionResponseConnection;
declare function CreateConnectionResponseConnectionToJSON(json: any): CreateConnectionResponseConnection;
declare function CreateConnectionResponseConnectionToJSONTyped(value?: CreateConnectionResponseConnection | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateConnectionResponse
*/
interface CreateConnectionResponse {
/**
*
* @type {string}
* @memberof CreateConnectionResponse
*/
message?: string;
/**
*
* @type {string}
* @memberof CreateConnectionResponse
*/
code?: string;
/**
*
* @type {CreateConnectionResponseConnection}
* @memberof CreateConnectionResponse
*/
connection?: CreateConnectionResponseConnection;
}
/**
* Check if a given object implements the CreateConnectionResponse interface.
*/
declare function instanceOfCreateConnectionResponse(value: object): value is CreateConnectionResponse;
declare function CreateConnectionResponseFromJSON(json: any): CreateConnectionResponse;
declare function CreateConnectionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateConnectionResponse;
declare function CreateConnectionResponseToJSON(json: any): CreateConnectionResponse;
declare function CreateConnectionResponseToJSONTyped(value?: CreateConnectionResponse | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateFeatureFlagRequest
*/
interface CreateFeatureFlagRequest {
/**
* The name of the flag.
* @type {string}
* @memberof CreateFeatureFlagRequest
*/
name: string;
/**
* Description of the flag purpose.
* @type {string}
* @memberof CreateFeatureFlagRequest
*/
description?: string;
/**
* The flag identifier to use in code.
* @type {string}
* @memberof CreateFeatureFlagRequest
*/
key: string;
/**
* The variable type.
* @type {string}
* @memberof CreateFeatureFlagRequest
*/
type: CreateFeatureFlagRequestTypeEnum;
/**
* Allow the flag to be overridden at a different level.
* @type {string}
* @memberof CreateFeatureFlagRequest
*/
allowOverrideLevel?: CreateFeatureFlagRequestAllowOverrideLevelEnum;
/**
* Default value for the flag used by environments and organizations.
* @type {string}
* @memberof CreateFeatureFlagRequest
*/
defaultValue: string;
}
/**
* @export
*/
declare const CreateFeatureFlagRequestTypeEnum: {
readonly Str: "str";
readonly Int: "int";
readonly Bool: "bool";
};
type CreateFeatureFlagRequestTypeEnum = typeof CreateFeatureFlagRequestTypeEnum[keyof typeof CreateFeatureFlagRequestTypeEnum];
/**
* @export
*/
declare const CreateFeatureFlagRequestAllowOverrideLevelEnum: {
readonly Env: "env";
readonly Org: "org";
readonly Usr: "usr";
};
type CreateFeatureFlagRequestAllowOverrideLevelEnum = typeof CreateFeatureFlagRequestAllowOverrideLevelEnum[keyof typeof CreateFeatureFlagRequestAllowOverrideLevelEnum];
/**
* Check if a given object implements the CreateFeatureFlagRequest interface.
*/
declare function instanceOfCreateFeatureFlagRequest(value: object): value is CreateFeatureFlagRequest;
declare function CreateFeatureFlagRequestFromJSON(json: any): CreateFeatureFlagRequest;
declare function CreateFeatureFlagRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFeatureFlagRequest;
declare function CreateFeatureFlagRequestToJSON(json: any): CreateFeatureFlagRequest;
declare function CreateFeatureFlagRequestToJSONTyped(value?: CreateFeatureFlagRequest | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateIdentityResponseIdentity
*/
interface CreateIdentityResponseIdentity {
/**
* The identity's ID.
* @type {string}
* @memberof CreateIdentityResponseIdentity
*/
id?: string;
}
/**
* Check if a given object implements the CreateIdentityResponseIdentity interface.
*/
declare function instanceOfCreateIdentityResponseIdentity(value: object): value is CreateIdentityResponseIdentity;
declare function CreateIdentityResponseIdentityFromJSON(json: any): CreateIdentityResponseIdentity;
declare function CreateIdentityResponseIdentityFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateIdentityResponseIdentity;
declare function CreateIdentityResponseIdentityToJSON(json: any): CreateIdentityResponseIdentity;
declare function CreateIdentityResponseIdentityToJSONTyped(value?: CreateIdentityResponseIdentity | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateIdentityResponse
*/
interface CreateIdentityResponse {
/**
*
* @type {string}
* @memberof CreateIdentityResponse
*/
message?: string;
/**
*
* @type {string}
* @memberof CreateIdentityResponse
*/
code?: string;
/**
*
* @type {CreateIdentityResponseIdentity}
* @memberof CreateIdentityResponse
*/
identity?: CreateIdentityResponseIdentity;
}
/**
* Check if a given object implements the CreateIdentityResponse interface.
*/
declare function instanceOfCreateIdentityResponse(value: object): value is CreateIdentityResponse;
declare function CreateIdentityResponseFromJSON(json: any): CreateIdentityResponse;
declare function CreateIdentityResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateIdentityResponse;
declare function CreateIdentityResponseToJSON(json: any): CreateIdentityResponse;
declare function CreateIdentityResponseToJSONTyped(value?: CreateIdentityResponse | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateOrganizationRequest
*/
interface CreateOrganizationRequest {
/**
* The organization's name.
* @type {string}
* @memberof CreateOrganizationRequest
*/
name: string;
/**
* The organization's feature flag settings.
* @type {{ [key: string]: string; }}
* @memberof CreateOrganizationRequest
*/
featureFlags?: {
[key: string]: string;
};
/**
* The organization's external identifier - commonly used when migrating from or mapping to other systems.
* @type {string}
* @memberof CreateOrganizationRequest
*/
externalId?: string;
/**
* The organization's brand settings - background color.
* @type {string}
* @memberof CreateOrganizationRequest
*/
backgroundColor?: string;
/**
* The organization's brand settings - button color.
* @type {string}
* @memberof CreateOrganizationRequest
*/
buttonColor?: string;
/**
* The organization's brand settings - button text color.
* @type {string}
* @memberof CreateOrganizationRequest
*/
buttonTextColor?: string;
/**
* The organization's brand settings - link color.
* @type {string}
* @memberof CreateOrganizationRequest
*/
linkColor?: string;
/**
* The organization's brand settings - dark mode background color.
* @type {string}
* @memberof CreateOrganizationRequest
*/
backgroundColorDark?: string;
/**
* The organization's brand settings - dark mode button color.
* @type {string}
* @memberof CreateOrganizationRequest
*/
buttonColorDark?: string;
/**
* The organization's brand settings - dark mode button text color.
* @type {string}
* @memberof CreateOrganizationRequest
*/
buttonTextColorDark?: string;
/**
* The organization's brand settings - dark mode link color.
* @type {string}
* @memberof CreateOrganizationRequest
*/
linkColorDark?: string;
/**
* The organization's brand settings - theme/mode 'light' | 'dark' | 'user_preference'.
* @type {string}
* @memberof CreateOrganizationRequest
*/
themeCode?: string;
/**
* A unique handle for the organization - can be used for dynamic callback urls.
* @type {string}
* @memberof CreateOrganizationRequest
*/
handle?: string;
/**
* If users become members of this organization when the org code is supplied during authentication.
* @type {boolean}
* @memberof CreateOrganizationRequest
*/
isAllowRegistrations?: boolean;
/**
* Enable custom auth connections for this organization.
* @type {boolean}
* @memberof CreateOrganizationRequest
*/
isCustomAuthConnectionsEnabled?: boolean;
}
/**
* @export
*/
declare const CreateOrganizationRequestFeatureFlagsEnum: {
readonly Str: "str";
readonly Int: "int";
readonly Bool: "bool";
};
type CreateOrganizationRequestFeatureFlagsEnum = typeof CreateOrganizationRequestFeatureFlagsEnum[keyof typeof CreateOrganizationRequestFeatureFlagsEnum];
/**
* Check if a given object implements the CreateOrganizationRequest interface.
*/
declare function instanceOfCreateOrganizationRequest(value: object): value is CreateOrganizationRequest;
declare function CreateOrganizationRequestFromJSON(json: any): CreateOrganizationRequest;
declare function CreateOrganizationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrganizationRequest;
declare function CreateOrganizationRequestToJSON(json: any): CreateOrganizationRequest;
declare function CreateOrganizationRequestToJSONTyped(value?: CreateOrganizationRequest | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateOrganizationResponseOrganization
*/
interface CreateOrganizationResponseOrganization {
/**
* The organization's unique code.
* @type {string}
* @memberof CreateOrganizationResponseOrganization
*/
code?: string;
}
/**
* Check if a given object implements the CreateOrganizationResponseOrganization interface.
*/
declare function instanceOfCreateOrganizationResponseOrganization(value: object): value is CreateOrganizationResponseOrganization;
declare function CreateOrganizationResponseOrganizationFromJSON(json: any): CreateOrganizationResponseOrganization;
declare function CreateOrganizationResponseOrganizationFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrganizationResponseOrganization;
declare function CreateOrganizationResponseOrganizationToJSON(json: any): CreateOrganizationResponseOrganization;
declare function CreateOrganizationResponseOrganizationToJSONTyped(value?: CreateOrganizationResponseOrganization | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateOrganizationResponse
*/
interface CreateOrganizationResponse {
/**
* Response message.
* @type {string}
* @memberof CreateOrganizationResponse
*/
message?: string;
/**
* Response code.
* @type {string}
* @memberof CreateOrganizationResponse
*/
code?: string;
/**
*
* @type {CreateOrganizationResponseOrganization}
* @memberof CreateOrganizationResponse
*/
organization?: CreateOrganizationResponseOrganization;
}
/**
* Check if a given object implements the CreateOrganizationResponse interface.
*/
declare function instanceOfCreateOrganizationResponse(value: object): value is CreateOrganizationResponse;
declare function CreateOrganizationResponseFromJSON(json: any): CreateOrganizationResponse;
declare function CreateOrganizationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrganizationResponse;
declare function CreateOrganizationResponseToJSON(json: any): CreateOrganizationResponse;
declare function CreateOrganizationResponseToJSONTyped(value?: CreateOrganizationResponse | null, ignoreDiscriminator?: boolean): any;
/**
* Kinde Management API
* Provides endpoints to manage your Kinde Businesses
*
* The version of the OpenAPI document: 1
* Contact: support@kinde.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface CreateOrganizationUserPermiss