chore: regenerate api client for login-related (#6728)

#### What type of PR is this?

/area core
/kind cleanup
/milestone 2.20.x

#### What this PR does / why we need it:

重新生成 OpenAPI 定义和 API Client,在 https://github.com/halo-dev/halo/pull/6488 中忘了重新生成。

#### Does this PR introduce a user-facing change?

```release-note
None
```
pull/6730/head
Ryan Wang 2024-09-29 15:47:46 +08:00 committed by GitHub
parent f4e3c25035
commit 2c849d8361
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 65 additions and 1268 deletions

View File

@ -6512,123 +6512,6 @@
]
}
},
"/apis/api.halo.run/v1alpha1/users/-/send-password-reset-email": {
"post": {
"description": "Send password reset email when forgot password",
"operationId": "SendPasswordResetEmail",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/PasswordResetEmailRequest"
}
}
},
"required": true
},
"responses": {
"204 NO_CONTENT": {
"content": {},
"description": "default response"
}
},
"tags": [
"UserV1alpha1Public"
]
}
},
"/apis/api.halo.run/v1alpha1/users/-/send-register-verify-email": {
"post": {
"description": "Send registration verification email, which can be called when mustVerifyEmailOnRegistration in user settings is true",
"operationId": "SendRegisterVerifyEmail",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/RegisterVerifyEmailRequest"
}
}
},
"required": true
},
"responses": {
"204 NO_CONTENT": {
"content": {},
"description": "default response"
}
},
"tags": [
"UserV1alpha1Public"
]
}
},
"/apis/api.halo.run/v1alpha1/users/-/signup": {
"post": {
"description": "Sign up a new user",
"operationId": "SignUp",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SignUpRequest"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": "default response"
}
},
"tags": [
"UserV1alpha1Public"
]
}
},
"/apis/api.halo.run/v1alpha1/users/{name}/reset-password": {
"put": {
"description": "Reset password by token",
"operationId": "ResetPasswordByToken",
"parameters": [
{
"description": "The name of the user",
"in": "path",
"name": "name",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordRequest"
}
}
},
"required": true
},
"responses": {
"204 NO_CONTENT": {
"content": {},
"description": "default response"
}
},
"tags": [
"UserV1alpha1Public"
]
}
},
"/apis/api.notification.halo.run/v1alpha1/notifiers/{name}/receiver-config": {
"get": {
"description": "Fetch receiver config of notifier",
@ -15655,27 +15538,6 @@
"PersonalAccessTokenV1alpha1Uc"
]
}
},
"/login/public-key": {
"get": {
"description": "Read public key for encrypting password.",
"operationId": "GetPublicKey",
"responses": {
"default": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/PublicKeyResponse"
}
}
},
"description": "default response"
}
},
"tags": [
"Login"
]
}
}
},
"components": {
@ -16036,6 +15898,13 @@
],
"type": "object",
"properties": {
"authType": {
"type": "string",
"enum": [
"FORM",
"OAUTH2"
]
},
"authenticationUrl": {
"type": "string",
"description": "Authentication url of the auth provider"
@ -16059,10 +15928,16 @@
"logo": {
"type": "string"
},
"method": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"rememberMeSupport": {
"type": "boolean"
},
"settingRef": {
"$ref": "#/components/schemas/SettingRef"
},
@ -19844,21 +19719,6 @@
}
}
},
"PasswordResetEmailRequest": {
"required": [
"email",
"username"
],
"type": "object",
"properties": {
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"PatSpec": {
"required": [
"name",
@ -20792,14 +20652,6 @@
}
}
},
"PublicKeyResponse": {
"type": "object",
"properties": {
"base64Format": {
"type": "string"
}
}
},
"Reason": {
"required": [
"apiVersion",
@ -21184,17 +21036,6 @@
},
"description": "Extension reference object. The name is mandatory"
},
"RegisterVerifyEmailRequest": {
"required": [
"email"
],
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"RememberMeToken": {
"required": [
"apiVersion",
@ -21623,22 +21464,6 @@
}
}
},
"ResetPasswordRequest": {
"required": [
"newPassword",
"token"
],
"type": "object",
"properties": {
"newPassword": {
"minLength": 6,
"type": "string"
},
"token": {
"type": "string"
}
}
},
"RestoreRequest": {
"type": "object",
"properties": {
@ -22391,27 +22216,6 @@
}
}
},
"SignUpRequest": {
"required": [
"password",
"user"
],
"type": "object",
"properties": {
"password": {
"minLength": 6,
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"verifyCode": {
"maxLength": 6,
"minLength": 6,
"type": "string"
}
}
},
"SinglePage": {
"required": [
"apiVersion",

View File

@ -3629,6 +3629,13 @@
],
"type": "object",
"properties": {
"authType": {
"type": "string",
"enum": [
"FORM",
"OAUTH2"
]
},
"authenticationUrl": {
"type": "string",
"description": "Authentication url of the auth provider"
@ -3652,10 +3659,16 @@
"logo": {
"type": "string"
},
"method": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"rememberMeSupport": {
"type": "boolean"
},
"settingRef": {
"$ref": "#/components/schemas/SettingRef"
},

View File

@ -8671,6 +8671,13 @@
],
"type": "object",
"properties": {
"authType": {
"type": "string",
"enum": [
"FORM",
"OAUTH2"
]
},
"authenticationUrl": {
"type": "string",
"description": "Authentication url of the auth provider"
@ -8694,10 +8701,16 @@
"logo": {
"type": "string"
},
"method": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int32"
},
"rememberMeSupport": {
"type": "boolean"
},
"settingRef": {
"$ref": "#/components/schemas/SettingRef"
},

View File

@ -506,123 +506,6 @@
"MetricsV1alpha1Public"
]
}
},
"/apis/api.halo.run/v1alpha1/users/-/send-password-reset-email": {
"post": {
"description": "Send password reset email when forgot password",
"operationId": "SendPasswordResetEmail",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/PasswordResetEmailRequest"
}
}
},
"required": true
},
"responses": {
"204 NO_CONTENT": {
"content": {},
"description": "default response"
}
},
"tags": [
"UserV1alpha1Public"
]
}
},
"/apis/api.halo.run/v1alpha1/users/-/send-register-verify-email": {
"post": {
"description": "Send registration verification email, which can be called when mustVerifyEmailOnRegistration in user settings is true",
"operationId": "SendRegisterVerifyEmail",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/RegisterVerifyEmailRequest"
}
}
},
"required": true
},
"responses": {
"204 NO_CONTENT": {
"content": {},
"description": "default response"
}
},
"tags": [
"UserV1alpha1Public"
]
}
},
"/apis/api.halo.run/v1alpha1/users/-/signup": {
"post": {
"description": "Sign up a new user",
"operationId": "SignUp",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SignUpRequest"
}
}
},
"required": true
},
"responses": {
"default": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": "default response"
}
},
"tags": [
"UserV1alpha1Public"
]
}
},
"/apis/api.halo.run/v1alpha1/users/{name}/reset-password": {
"put": {
"description": "Reset password by token",
"operationId": "ResetPasswordByToken",
"parameters": [
{
"description": "The name of the user",
"in": "path",
"name": "name",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordRequest"
}
}
},
"required": true
},
"responses": {
"204 NO_CONTENT": {
"content": {},
"description": "default response"
}
},
"tags": [
"UserV1alpha1Public"
]
}
}
},
"components": {
@ -1244,33 +1127,6 @@
}
}
},
"LoginHistory": {
"required": [
"loginAt",
"sourceIp",
"successful",
"userAgent"
],
"type": "object",
"properties": {
"loginAt": {
"type": "string",
"format": "date-time"
},
"reason": {
"type": "string"
},
"sourceIp": {
"type": "string"
},
"successful": {
"type": "boolean"
},
"userAgent": {
"type": "string"
}
}
},
"MenuItemSpec": {
"type": "object",
"properties": {
@ -1488,21 +1344,6 @@
}
}
},
"PasswordResetEmailRequest": {
"required": [
"email",
"username"
],
"type": "object",
"properties": {
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"Ref": {
"required": [
"name"
@ -1528,17 +1369,6 @@
},
"description": "Extension reference object. The name is mandatory"
},
"RegisterVerifyEmailRequest": {
"required": [
"email"
],
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"RemoveOperation": {
"required": [
"op",
@ -1800,22 +1630,6 @@
}
}
},
"ResetPasswordRequest": {
"required": [
"newPassword",
"token"
],
"type": "object",
"properties": {
"newPassword": {
"minLength": 6,
"type": "string"
},
"token": {
"type": "string"
}
}
},
"SearchOption": {
"required": [
"keyword"
@ -1904,27 +1718,6 @@
}
}
},
"SignUpRequest": {
"required": [
"password",
"user"
],
"type": "object",
"properties": {
"password": {
"minLength": 6,
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User"
},
"verifyCode": {
"maxLength": 6,
"minLength": 6,
"type": "string"
}
}
},
"SiteStatsVo": {
"type": "object",
"properties": {
@ -1975,97 +1768,6 @@
}
}
},
"User": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"spec": {
"$ref": "#/components/schemas/UserSpec"
},
"status": {
"$ref": "#/components/schemas/UserStatus"
}
}
},
"UserSpec": {
"required": [
"displayName",
"email"
],
"type": "object",
"properties": {
"avatar": {
"type": "string"
},
"bio": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"displayName": {
"type": "string"
},
"email": {
"type": "string"
},
"emailVerified": {
"type": "boolean"
},
"loginHistoryLimit": {
"type": "integer",
"format": "int32"
},
"password": {
"type": "string"
},
"phone": {
"type": "string"
},
"registeredAt": {
"type": "string",
"format": "date-time"
},
"totpEncryptedSecret": {
"type": "string"
},
"twoFactorAuthEnabled": {
"type": "boolean"
}
}
},
"UserStatus": {
"type": "object",
"properties": {
"lastLoginAt": {
"type": "string",
"format": "date-time"
},
"loginHistories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoginHistory"
}
},
"permalink": {
"type": "string"
}
}
},
"VoteRequest": {
"type": "object",
"properties": {

View File

@ -19,7 +19,6 @@ import {
ExtensionPointDefinitionV1alpha1Api,
GroupV1alpha1Api,
IndicesV1alpha1ConsoleApi,
LoginApi,
MenuItemV1alpha1Api,
MenuV1alpha1Api,
MenuV1alpha1PublicApi,
@ -66,7 +65,6 @@ import {
UserConnectionV1alpha1Api,
UserV1alpha1Api,
UserV1alpha1ConsoleApi,
UserV1alpha1PublicApi,
} from "../src";
const defaultAxiosInstance = axios.create({
@ -281,7 +279,6 @@ function createConsoleApiClient(axiosInstance: AxiosInstance) {
baseURL,
axiosInstance
),
login: new LoginApi(undefined, baseURL, axiosInstance),
storage: {
attachment: new AttachmentV1alpha1ConsoleApi(
undefined,
@ -431,7 +428,6 @@ function createPublicApiClient(axiosInstance: AxiosInstance) {
return {
menu: new MenuV1alpha1PublicApi(undefined, baseURL, axiosInstance),
stats: new SystemV1alpha1PublicApi(undefined, baseURL, axiosInstance),
user: new UserV1alpha1PublicApi(undefined, baseURL, axiosInstance),
content: {
post: new PostV1alpha1PublicApi(undefined, baseURL, axiosInstance),
comment: new CommentV1alpha1PublicApi(undefined, baseURL, axiosInstance),

View File

@ -25,7 +25,6 @@ api/group-v1alpha1-api.ts
api/index-v1alpha1-public-api.ts
api/indices-v1alpha1-console-api.ts
api/local-thumbnail-v1alpha1-api.ts
api/login-api.ts
api/menu-item-v1alpha1-api.ts
api/menu-v1alpha1-api.ts
api/menu-v1alpha1-public-api.ts
@ -79,7 +78,6 @@ api/two-factor-auth-v1alpha1-uc-api.ts
api/user-connection-v1alpha1-api.ts
api/user-v1alpha1-api.ts
api/user-v1alpha1-console-api.ts
api/user-v1alpha1-public-api.ts
base.ts
common.ts
configuration.ts
@ -217,7 +215,6 @@ models/notifier-info.ts
models/notifier-setting-ref.ts
models/owner-info.ts
models/password-request.ts
models/password-reset-email-request.ts
models/pat-spec.ts
models/personal-access-token-list.ts
models/personal-access-token.ts
@ -240,7 +237,6 @@ models/post-spec.ts
models/post-status.ts
models/post-vo.ts
models/post.ts
models/public-key-response.ts
models/reason-attributes.ts
models/reason-list.ts
models/reason-property.ts
@ -256,7 +252,6 @@ models/reason-type-spec.ts
models/reason-type.ts
models/reason.ts
models/ref.ts
models/register-verify-email-request.ts
models/remember-me-token-list.ts
models/remember-me-token-spec.ts
models/remember-me-token.ts
@ -269,7 +264,6 @@ models/reply-status.ts
models/reply-vo-list.ts
models/reply-vo.ts
models/reply.ts
models/reset-password-request.ts
models/reverse-proxy-list.ts
models/reverse-proxy-rule.ts
models/reverse-proxy.ts
@ -292,7 +286,6 @@ models/setting-list.ts
models/setting-ref.ts
models/setting-spec.ts
models/setting.ts
models/sign-up-request.ts
models/single-page-list.ts
models/single-page-request.ts
models/single-page-spec.ts

View File

@ -37,7 +37,6 @@ export * from './api/group-v1alpha1-api';
export * from './api/index-v1alpha1-public-api';
export * from './api/indices-v1alpha1-console-api';
export * from './api/local-thumbnail-v1alpha1-api';
export * from './api/login-api';
export * from './api/menu-item-v1alpha1-api';
export * from './api/menu-v1alpha1-api';
export * from './api/menu-v1alpha1-public-api';
@ -91,5 +90,4 @@ export * from './api/two-factor-auth-v1alpha1-uc-api';
export * from './api/user-connection-v1alpha1-api';
export * from './api/user-v1alpha1-api';
export * from './api/user-v1alpha1-console-api';
export * from './api/user-v1alpha1-public-api';

View File

@ -1,128 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* Halo
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.20.0-SNAPSHOT
*
*
* 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 { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
// @ts-ignore
import { PublicKeyResponse } from '../models';
/**
* LoginApi - axios parameter creator
* @export
*/
export const LoginApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Read public key for encrypting password.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPublicKey: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/login/public-key`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication bearerAuth required
// http bearer authentication required
await setBearerAuthToObject(localVarHeaderParameter, configuration)
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* LoginApi - functional programming interface
* @export
*/
export const LoginApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = LoginApiAxiosParamCreator(configuration)
return {
/**
* Read public key for encrypting password.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getPublicKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicKeyResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicKey(options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['LoginApi.getPublicKey']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* LoginApi - factory interface
* @export
*/
export const LoginApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = LoginApiFp(configuration)
return {
/**
* Read public key for encrypting password.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPublicKey(options?: RawAxiosRequestConfig): AxiosPromise<PublicKeyResponse> {
return localVarFp.getPublicKey(options).then((request) => request(axios, basePath));
},
};
};
/**
* LoginApi - object-oriented interface
* @export
* @class LoginApi
* @extends {BaseAPI}
*/
export class LoginApi extends BaseAPI {
/**
* Read public key for encrypting password.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LoginApi
*/
public getPublicKey(options?: RawAxiosRequestConfig) {
return LoginApiFp(this.configuration).getPublicKey(options).then((request) => request(this.axios, this.basePath));
}
}

View File

@ -1,438 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* Halo
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.20.0-SNAPSHOT
*
*
* 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 { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
// @ts-ignore
import { PasswordResetEmailRequest } from '../models';
// @ts-ignore
import { RegisterVerifyEmailRequest } from '../models';
// @ts-ignore
import { ResetPasswordRequest } from '../models';
// @ts-ignore
import { SignUpRequest } from '../models';
// @ts-ignore
import { User } from '../models';
/**
* UserV1alpha1PublicApi - axios parameter creator
* @export
*/
export const UserV1alpha1PublicApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Reset password by token
* @param {string} name The name of the user
* @param {ResetPasswordRequest} resetPasswordRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetPasswordByToken: async (name: string, resetPasswordRequest: ResetPasswordRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'name' is not null or undefined
assertParamExists('resetPasswordByToken', 'name', name)
// verify required parameter 'resetPasswordRequest' is not null or undefined
assertParamExists('resetPasswordByToken', 'resetPasswordRequest', resetPasswordRequest)
const localVarPath = `/apis/api.halo.run/v1alpha1/users/{name}/reset-password`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication bearerAuth required
// http bearer authentication required
await setBearerAuthToObject(localVarHeaderParameter, configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(resetPasswordRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Send password reset email when forgot password
* @param {PasswordResetEmailRequest} passwordResetEmailRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sendPasswordResetEmail: async (passwordResetEmailRequest: PasswordResetEmailRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'passwordResetEmailRequest' is not null or undefined
assertParamExists('sendPasswordResetEmail', 'passwordResetEmailRequest', passwordResetEmailRequest)
const localVarPath = `/apis/api.halo.run/v1alpha1/users/-/send-password-reset-email`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication bearerAuth required
// http bearer authentication required
await setBearerAuthToObject(localVarHeaderParameter, configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(passwordResetEmailRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Send registration verification email, which can be called when mustVerifyEmailOnRegistration in user settings is true
* @param {RegisterVerifyEmailRequest} registerVerifyEmailRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sendRegisterVerifyEmail: async (registerVerifyEmailRequest: RegisterVerifyEmailRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'registerVerifyEmailRequest' is not null or undefined
assertParamExists('sendRegisterVerifyEmail', 'registerVerifyEmailRequest', registerVerifyEmailRequest)
const localVarPath = `/apis/api.halo.run/v1alpha1/users/-/send-register-verify-email`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication bearerAuth required
// http bearer authentication required
await setBearerAuthToObject(localVarHeaderParameter, configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(registerVerifyEmailRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Sign up a new user
* @param {SignUpRequest} signUpRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
signUp: async (signUpRequest: SignUpRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'signUpRequest' is not null or undefined
assertParamExists('signUp', 'signUpRequest', signUpRequest)
const localVarPath = `/apis/api.halo.run/v1alpha1/users/-/signup`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication bearerAuth required
// http bearer authentication required
await setBearerAuthToObject(localVarHeaderParameter, configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(signUpRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* UserV1alpha1PublicApi - functional programming interface
* @export
*/
export const UserV1alpha1PublicApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = UserV1alpha1PublicApiAxiosParamCreator(configuration)
return {
/**
* Reset password by token
* @param {string} name The name of the user
* @param {ResetPasswordRequest} resetPasswordRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async resetPasswordByToken(name: string, resetPasswordRequest: ResetPasswordRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.resetPasswordByToken(name, resetPasswordRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserV1alpha1PublicApi.resetPasswordByToken']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Send password reset email when forgot password
* @param {PasswordResetEmailRequest} passwordResetEmailRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async sendPasswordResetEmail(passwordResetEmailRequest: PasswordResetEmailRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.sendPasswordResetEmail(passwordResetEmailRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserV1alpha1PublicApi.sendPasswordResetEmail']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Send registration verification email, which can be called when mustVerifyEmailOnRegistration in user settings is true
* @param {RegisterVerifyEmailRequest} registerVerifyEmailRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async sendRegisterVerifyEmail(registerVerifyEmailRequest: RegisterVerifyEmailRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.sendRegisterVerifyEmail(registerVerifyEmailRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserV1alpha1PublicApi.sendRegisterVerifyEmail']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Sign up a new user
* @param {SignUpRequest} signUpRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async signUp(signUpRequest: SignUpRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.signUp(signUpRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserV1alpha1PublicApi.signUp']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* UserV1alpha1PublicApi - factory interface
* @export
*/
export const UserV1alpha1PublicApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = UserV1alpha1PublicApiFp(configuration)
return {
/**
* Reset password by token
* @param {UserV1alpha1PublicApiResetPasswordByTokenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetPasswordByToken(requestParameters: UserV1alpha1PublicApiResetPasswordByTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
return localVarFp.resetPasswordByToken(requestParameters.name, requestParameters.resetPasswordRequest, options).then((request) => request(axios, basePath));
},
/**
* Send password reset email when forgot password
* @param {UserV1alpha1PublicApiSendPasswordResetEmailRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sendPasswordResetEmail(requestParameters: UserV1alpha1PublicApiSendPasswordResetEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
return localVarFp.sendPasswordResetEmail(requestParameters.passwordResetEmailRequest, options).then((request) => request(axios, basePath));
},
/**
* Send registration verification email, which can be called when mustVerifyEmailOnRegistration in user settings is true
* @param {UserV1alpha1PublicApiSendRegisterVerifyEmailRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sendRegisterVerifyEmail(requestParameters: UserV1alpha1PublicApiSendRegisterVerifyEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
return localVarFp.sendRegisterVerifyEmail(requestParameters.registerVerifyEmailRequest, options).then((request) => request(axios, basePath));
},
/**
* Sign up a new user
* @param {UserV1alpha1PublicApiSignUpRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
signUp(requestParameters: UserV1alpha1PublicApiSignUpRequest, options?: RawAxiosRequestConfig): AxiosPromise<User> {
return localVarFp.signUp(requestParameters.signUpRequest, options).then((request) => request(axios, basePath));
},
};
};
/**
* Request parameters for resetPasswordByToken operation in UserV1alpha1PublicApi.
* @export
* @interface UserV1alpha1PublicApiResetPasswordByTokenRequest
*/
export interface UserV1alpha1PublicApiResetPasswordByTokenRequest {
/**
* The name of the user
* @type {string}
* @memberof UserV1alpha1PublicApiResetPasswordByToken
*/
readonly name: string
/**
*
* @type {ResetPasswordRequest}
* @memberof UserV1alpha1PublicApiResetPasswordByToken
*/
readonly resetPasswordRequest: ResetPasswordRequest
}
/**
* Request parameters for sendPasswordResetEmail operation in UserV1alpha1PublicApi.
* @export
* @interface UserV1alpha1PublicApiSendPasswordResetEmailRequest
*/
export interface UserV1alpha1PublicApiSendPasswordResetEmailRequest {
/**
*
* @type {PasswordResetEmailRequest}
* @memberof UserV1alpha1PublicApiSendPasswordResetEmail
*/
readonly passwordResetEmailRequest: PasswordResetEmailRequest
}
/**
* Request parameters for sendRegisterVerifyEmail operation in UserV1alpha1PublicApi.
* @export
* @interface UserV1alpha1PublicApiSendRegisterVerifyEmailRequest
*/
export interface UserV1alpha1PublicApiSendRegisterVerifyEmailRequest {
/**
*
* @type {RegisterVerifyEmailRequest}
* @memberof UserV1alpha1PublicApiSendRegisterVerifyEmail
*/
readonly registerVerifyEmailRequest: RegisterVerifyEmailRequest
}
/**
* Request parameters for signUp operation in UserV1alpha1PublicApi.
* @export
* @interface UserV1alpha1PublicApiSignUpRequest
*/
export interface UserV1alpha1PublicApiSignUpRequest {
/**
*
* @type {SignUpRequest}
* @memberof UserV1alpha1PublicApiSignUp
*/
readonly signUpRequest: SignUpRequest
}
/**
* UserV1alpha1PublicApi - object-oriented interface
* @export
* @class UserV1alpha1PublicApi
* @extends {BaseAPI}
*/
export class UserV1alpha1PublicApi extends BaseAPI {
/**
* Reset password by token
* @param {UserV1alpha1PublicApiResetPasswordByTokenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserV1alpha1PublicApi
*/
public resetPasswordByToken(requestParameters: UserV1alpha1PublicApiResetPasswordByTokenRequest, options?: RawAxiosRequestConfig) {
return UserV1alpha1PublicApiFp(this.configuration).resetPasswordByToken(requestParameters.name, requestParameters.resetPasswordRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
* Send password reset email when forgot password
* @param {UserV1alpha1PublicApiSendPasswordResetEmailRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserV1alpha1PublicApi
*/
public sendPasswordResetEmail(requestParameters: UserV1alpha1PublicApiSendPasswordResetEmailRequest, options?: RawAxiosRequestConfig) {
return UserV1alpha1PublicApiFp(this.configuration).sendPasswordResetEmail(requestParameters.passwordResetEmailRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
* Send registration verification email, which can be called when mustVerifyEmailOnRegistration in user settings is true
* @param {UserV1alpha1PublicApiSendRegisterVerifyEmailRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserV1alpha1PublicApi
*/
public sendRegisterVerifyEmail(requestParameters: UserV1alpha1PublicApiSendRegisterVerifyEmailRequest, options?: RawAxiosRequestConfig) {
return UserV1alpha1PublicApiFp(this.configuration).sendRegisterVerifyEmail(requestParameters.registerVerifyEmailRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
* Sign up a new user
* @param {UserV1alpha1PublicApiSignUpRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserV1alpha1PublicApi
*/
public signUp(requestParameters: UserV1alpha1PublicApiSignUpRequest, options?: RawAxiosRequestConfig) {
return UserV1alpha1PublicApiFp(this.configuration).signUp(requestParameters.signUpRequest, options).then((request) => request(this.axios, this.basePath));
}
}

View File

@ -26,6 +26,12 @@ import { SettingRef } from './setting-ref';
* @interface AuthProviderSpec
*/
export interface AuthProviderSpec {
/**
*
* @type {string}
* @memberof AuthProviderSpec
*/
'authType'?: AuthProviderSpecAuthTypeEnum;
/**
* Authentication url of the auth provider
* @type {string}
@ -68,12 +74,24 @@ export interface AuthProviderSpec {
* @memberof AuthProviderSpec
*/
'logo'?: string;
/**
*
* @type {string}
* @memberof AuthProviderSpec
*/
'method'?: string;
/**
*
* @type {number}
* @memberof AuthProviderSpec
*/
'priority'?: number;
/**
*
* @type {boolean}
* @memberof AuthProviderSpec
*/
'rememberMeSupport'?: boolean;
/**
*
* @type {SettingRef}
@ -94,3 +112,11 @@ export interface AuthProviderSpec {
'website'?: string;
}
export const AuthProviderSpecAuthTypeEnum = {
Form: 'FORM',
Oauth2: 'OAUTH2'
} as const;
export type AuthProviderSpecAuthTypeEnum = typeof AuthProviderSpecAuthTypeEnum[keyof typeof AuthProviderSpecAuthTypeEnum];

View File

@ -129,7 +129,6 @@ export * from './notifier-info';
export * from './notifier-setting-ref';
export * from './owner-info';
export * from './password-request';
export * from './password-reset-email-request';
export * from './pat-spec';
export * from './personal-access-token';
export * from './personal-access-token-list';
@ -152,7 +151,6 @@ export * from './post-request';
export * from './post-spec';
export * from './post-status';
export * from './post-vo';
export * from './public-key-response';
export * from './reason';
export * from './reason-attributes';
export * from './reason-list';
@ -168,7 +166,6 @@ export * from './reason-type-notifier-matrix';
export * from './reason-type-notifier-request';
export * from './reason-type-spec';
export * from './ref';
export * from './register-verify-email-request';
export * from './remember-me-token';
export * from './remember-me-token-list';
export * from './remember-me-token-spec';
@ -181,7 +178,6 @@ export * from './reply-spec';
export * from './reply-status';
export * from './reply-vo';
export * from './reply-vo-list';
export * from './reset-password-request';
export * from './reverse-proxy';
export * from './reverse-proxy-list';
export * from './reverse-proxy-rule';
@ -204,7 +200,6 @@ export * from './setting-form';
export * from './setting-list';
export * from './setting-ref';
export * from './setting-spec';
export * from './sign-up-request';
export * from './single-page';
export * from './single-page-list';
export * from './single-page-request';

View File

@ -1,36 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* Halo
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.20.0-SNAPSHOT
*
*
* 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 PasswordResetEmailRequest
*/
export interface PasswordResetEmailRequest {
/**
*
* @type {string}
* @memberof PasswordResetEmailRequest
*/
'email': string;
/**
*
* @type {string}
* @memberof PasswordResetEmailRequest
*/
'username': string;
}

View File

@ -1,30 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* Halo
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.20.0-SNAPSHOT
*
*
* 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 PublicKeyResponse
*/
export interface PublicKeyResponse {
/**
*
* @type {string}
* @memberof PublicKeyResponse
*/
'base64Format'?: string;
}

View File

@ -1,30 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* Halo
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.20.0-SNAPSHOT
*
*
* 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 RegisterVerifyEmailRequest
*/
export interface RegisterVerifyEmailRequest {
/**
*
* @type {string}
* @memberof RegisterVerifyEmailRequest
*/
'email': string;
}

View File

@ -1,36 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* Halo
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.20.0-SNAPSHOT
*
*
* 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 ResetPasswordRequest
*/
export interface ResetPasswordRequest {
/**
*
* @type {string}
* @memberof ResetPasswordRequest
*/
'newPassword': string;
/**
*
* @type {string}
* @memberof ResetPasswordRequest
*/
'token': string;
}

View File

@ -1,45 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* Halo
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.20.0-SNAPSHOT
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
// May contain unused imports in some cases
// @ts-ignore
import { User } from './user';
/**
*
* @export
* @interface SignUpRequest
*/
export interface SignUpRequest {
/**
*
* @type {string}
* @memberof SignUpRequest
*/
'password': string;
/**
*
* @type {User}
* @memberof SignUpRequest
*/
'user': User;
/**
*
* @type {string}
* @memberof SignUpRequest
*/
'verifyCode'?: string;
}