Files
full-stack-fastapi-template/frontend/src/client/services.ts

524 lines
10 KiB
TypeScript
Raw Normal View History

import type { CancelablePromise } from './core/CancelablePromise';
import { OpenAPI } from './core/OpenAPI';
import { request as __request } from './core/request';
import type { Body_login_login_access_token,Message,NewPassword,Token,UserOut,UpdatePassword,UserCreate,UserRegister,UsersOut,UserUpdate,UserUpdateMe,ItemCreate,ItemOut,ItemsOut,ItemUpdate } from './models';
export type TDataLoginAccessToken = {
formData: Body_login_login_access_token
}
export type TDataRecoverPassword = {
email: string
}
export type TDataResetPassword = {
requestBody: NewPassword
}
export type TDataRecoverPasswordHtmlContent = {
email: string
}
export class LoginService {
/**
* Login Access Token
* OAuth2 compatible token login, get an access token for future requests
* @returns Token Successful Response
* @throws ApiError
*/
public static loginAccessToken(data: TDataLoginAccessToken): CancelablePromise<Token> {
const {
formData,
} = data;
return __request(OpenAPI, {
method: 'POST',
url: '/api/v1/login/access-token',
formData: formData,
mediaType: 'application/x-www-form-urlencoded',
errors: {
422: `Validation Error`,
},
});
}
/**
* Test Token
* Test access token
* @returns UserOut Successful Response
* @throws ApiError
*/
public static testToken(): CancelablePromise<UserOut> {
return __request(OpenAPI, {
method: 'POST',
url: '/api/v1/login/test-token',
});
}
/**
* Recover Password
* Password Recovery
* @returns Message Successful Response
* @throws ApiError
*/
public static recoverPassword(data: TDataRecoverPassword): CancelablePromise<Message> {
const {
email,
} = data;
return __request(OpenAPI, {
method: 'POST',
url: '/api/v1/password-recovery/{email}',
path: {
email
},
errors: {
422: `Validation Error`,
},
});
}
/**
* Reset Password
* Reset password
* @returns Message Successful Response
* @throws ApiError
*/
public static resetPassword(data: TDataResetPassword): CancelablePromise<Message> {
const {
requestBody,
} = data;
return __request(OpenAPI, {
method: 'POST',
url: '/api/v1/reset-password/',
body: requestBody,
mediaType: 'application/json',
errors: {
422: `Validation Error`,
},
});
}
/**
* Recover Password Html Content
* HTML Content for Password Recovery
* @returns string Successful Response
* @throws ApiError
*/
public static recoverPasswordHtmlContent(data: TDataRecoverPasswordHtmlContent): CancelablePromise<string> {
const {
email,
} = data;
return __request(OpenAPI, {
method: 'POST',
url: '/api/v1/password-recovery-html-content/{email}',
path: {
email
},
errors: {
422: `Validation Error`,
},
});
}
}
export type TDataReadUsers = {
limit?: number
skip?: number
}
export type TDataCreateUser = {
requestBody: UserCreate
}
export type TDataUpdateUserMe = {
requestBody: UserUpdateMe
}
export type TDataUpdatePasswordMe = {
requestBody: UpdatePassword
}
export type TDataRegisterUser = {
requestBody: UserRegister
}
export type TDataReadUserById = {
userId: number
}
export type TDataUpdateUser = {
requestBody: UserUpdate
userId: number
}
export type TDataDeleteUser = {
userId: number
}
export class UsersService {
/**
* Read Users
* Retrieve users.
* @returns UsersOut Successful Response
* @throws ApiError
*/
public static readUsers(data: TDataReadUsers = {}): CancelablePromise<UsersOut> {
const {
limit = 100,
skip = 0,
} = data;
return __request(OpenAPI, {
method: 'GET',
url: '/api/v1/users/',
query: {
skip, limit
},
errors: {
422: `Validation Error`,
},
});
}
/**
* Create User
* Create new user.
* @returns UserOut Successful Response
* @throws ApiError
*/
public static createUser(data: TDataCreateUser): CancelablePromise<UserOut> {
const {
requestBody,
} = data;
return __request(OpenAPI, {
method: 'POST',
url: '/api/v1/users/',
body: requestBody,
mediaType: 'application/json',
errors: {
422: `Validation Error`,
},
});
}
/**
* Read User Me
* Get current user.
* @returns UserOut Successful Response
* @throws ApiError
*/
public static readUserMe(): CancelablePromise<UserOut> {
return __request(OpenAPI, {
method: 'GET',
url: '/api/v1/users/me',
});
}
/**
* Update User Me
* Update own user.
* @returns UserOut Successful Response
* @throws ApiError
*/
public static updateUserMe(data: TDataUpdateUserMe): CancelablePromise<UserOut> {
const {
requestBody,
} = data;
return __request(OpenAPI, {
method: 'PATCH',
url: '/api/v1/users/me',
body: requestBody,
mediaType: 'application/json',
errors: {
422: `Validation Error`,
},
});
}
/**
* Update Password Me
* Update own password.
* @returns Message Successful Response
* @throws ApiError
*/
public static updatePasswordMe(data: TDataUpdatePasswordMe): CancelablePromise<Message> {
const {
requestBody,
} = data;
return __request(OpenAPI, {
method: 'PATCH',
url: '/api/v1/users/me/password',
body: requestBody,
mediaType: 'application/json',
errors: {
422: `Validation Error`,
},
});
}
/**
* Register User
* Create new user without the need to be logged in.
* @returns UserOut Successful Response
* @throws ApiError
*/
public static registerUser(data: TDataRegisterUser): CancelablePromise<UserOut> {
const {
requestBody,
} = data;
return __request(OpenAPI, {
method: 'POST',
url: '/api/v1/users/signup',
body: requestBody,
mediaType: 'application/json',
errors: {
422: `Validation Error`,
},
});
}
/**
* Read User By Id
* Get a specific user by id.
* @returns UserOut Successful Response
* @throws ApiError
*/
public static readUserById(data: TDataReadUserById): CancelablePromise<UserOut> {
const {
userId,
} = data;
return __request(OpenAPI, {
method: 'GET',
url: '/api/v1/users/{user_id}',
path: {
user_id: userId
},
errors: {
422: `Validation Error`,
},
});
}
/**
* Update User
* Update a user.
* @returns UserOut Successful Response
* @throws ApiError
*/
public static updateUser(data: TDataUpdateUser): CancelablePromise<UserOut> {
const {
requestBody,
userId,
} = data;
return __request(OpenAPI, {
method: 'PATCH',
url: '/api/v1/users/{user_id}',
path: {
user_id: userId
},
body: requestBody,
mediaType: 'application/json',
errors: {
422: `Validation Error`,
},
});
}
/**
* Delete User
* Delete a user.
* @returns Message Successful Response
* @throws ApiError
*/
public static deleteUser(data: TDataDeleteUser): CancelablePromise<Message> {
const {
userId,
} = data;
return __request(OpenAPI, {
method: 'DELETE',
url: '/api/v1/users/{user_id}',
path: {
user_id: userId
},
errors: {
422: `Validation Error`,
},
});
}
}
export type TDataTestEmail = {
emailTo: string
}
export class UtilsService {
/**
* Test Email
* Test emails.
* @returns Message Successful Response
* @throws ApiError
*/
public static testEmail(data: TDataTestEmail): CancelablePromise<Message> {
const {
emailTo,
} = data;
return __request(OpenAPI, {
method: 'POST',
url: '/api/v1/utils/test-email/',
query: {
email_to: emailTo
},
errors: {
422: `Validation Error`,
},
});
}
}
export type TDataReadItems = {
limit?: number
skip?: number
}
export type TDataCreateItem = {
requestBody: ItemCreate
}
export type TDataReadItem = {
id: number
}
export type TDataUpdateItem = {
id: number
requestBody: ItemUpdate
}
export type TDataDeleteItem = {
id: number
}
export class ItemsService {
/**
* Read Items
* Retrieve items.
* @returns ItemsOut Successful Response
* @throws ApiError
*/
public static readItems(data: TDataReadItems = {}): CancelablePromise<ItemsOut> {
const {
limit = 100,
skip = 0,
} = data;
return __request(OpenAPI, {
method: 'GET',
url: '/api/v1/items/',
query: {
skip, limit
},
errors: {
422: `Validation Error`,
},
});
}
/**
* Create Item
* Create new item.
* @returns ItemOut Successful Response
* @throws ApiError
*/
public static createItem(data: TDataCreateItem): CancelablePromise<ItemOut> {
const {
requestBody,
} = data;
return __request(OpenAPI, {
method: 'POST',
url: '/api/v1/items/',
body: requestBody,
mediaType: 'application/json',
errors: {
422: `Validation Error`,
},
});
}
/**
* Read Item
* Get item by ID.
* @returns ItemOut Successful Response
* @throws ApiError
*/
public static readItem(data: TDataReadItem): CancelablePromise<ItemOut> {
const {
id,
} = data;
return __request(OpenAPI, {
method: 'GET',
url: '/api/v1/items/{id}',
path: {
id
},
errors: {
422: `Validation Error`,
},
});
}
/**
* Update Item
* Update an item.
* @returns ItemOut Successful Response
* @throws ApiError
*/
public static updateItem(data: TDataUpdateItem): CancelablePromise<ItemOut> {
const {
id,
requestBody,
} = data;
return __request(OpenAPI, {
method: 'PUT',
url: '/api/v1/items/{id}',
path: {
id
},
body: requestBody,
mediaType: 'application/json',
errors: {
422: `Validation Error`,
},
});
}
/**
* Delete Item
* Delete an item.
* @returns Message Successful Response
* @throws ApiError
*/
public static deleteItem(data: TDataDeleteItem): CancelablePromise<Message> {
const {
id,
} = data;
return __request(OpenAPI, {
method: 'DELETE',
url: '/api/v1/items/{id}',
path: {
id
},
errors: {
422: `Validation Error`,
},
});
}
}