← full-stack-fastapi-template / frontend/src/client/sdk.gen.ts
| 1 | // This file is auto-generated by @hey-api/openapi-ts |
| 2 | |
| 3 | import type { CancelablePromise } from './core/CancelablePromise'; |
| 4 | import { OpenAPI } from './core/OpenAPI'; |
| 5 | import { request as __request } from './core/request'; |
| 6 | import type { ItemsReadItemsData, ItemsReadItemsResponse, ItemsCreateItemData, ItemsCreateItemResponse, ItemsReadItemData, ItemsReadItemResponse, ItemsUpdateItemData, ItemsUpdateItemResponse, ItemsDeleteItemData, ItemsDeleteItemResponse, LoginLoginAccessTokenData, LoginLoginAccessTokenResponse, LoginTestTokenResponse, LoginRecoverPasswordData, LoginRecoverPasswordResponse, LoginResetPasswordData, LoginResetPasswordResponse, LoginRecoverPasswordHtmlContentData, LoginRecoverPasswordHtmlContentResponse, PrivateCreateUserData, PrivateCreateUserResponse, UsersReadUsersData, UsersReadUsersResponse, UsersCreateUserData, UsersCreateUserResponse, UsersReadUserMeResponse, UsersDeleteUserMeResponse, UsersUpdateUserMeData, UsersUpdateUserMeResponse, UsersUpdatePasswordMeData, UsersUpdatePasswordMeResponse, UsersRegisterUserData, UsersRegisterUserResponse, UsersReadUserByIdData, UsersReadUserByIdResponse, UsersUpdateUserData, UsersUpdateUserResponse, UsersDeleteUserData, UsersDeleteUserResponse, UtilsTestEmailData, UtilsTestEmailResponse, UtilsHealthCheckResponse } from './types.gen'; |
| 7 | |
| 8 | export class ItemsService { |
| 9 | /** |
| 10 | * Read Items |
| 11 | * Retrieve items. |
| 12 | * @param data The data for the request. |
| 13 | * @param data.skip |
| 14 | * @param data.limit |
| 15 | * @returns ItemsPublic Successful Response |
| 16 | * @throws ApiError |
| 17 | */ |
| 18 | public static readItems(data: ItemsReadItemsData = {}): CancelablePromise<ItemsReadItemsResponse> { |
| 19 | return __request(OpenAPI, { |
| 20 | method: 'GET', |
| 21 | url: '/api/v1/items/', |
| 22 | query: { |
| 23 | skip: data.skip, |
| 24 | limit: data.limit |
| 25 | }, |
| 26 | errors: { |
| 27 | 422: 'Validation Error' |
| 28 | } |
| 29 | }); |
| 30 | } |
| 31 | |
| 32 | /** |
| 33 | * Create Item |
| 34 | * Create new item. |
| 35 | * @param data The data for the request. |
| 36 | * @param data.requestBody |
| 37 | * @returns ItemPublic Successful Response |
| 38 | * @throws ApiError |
| 39 | */ |
| 40 | public static createItem(data: ItemsCreateItemData): CancelablePromise<ItemsCreateItemResponse> { |
| 41 | return __request(OpenAPI, { |
| 42 | method: 'POST', |
| 43 | url: '/api/v1/items/', |
| 44 | body: data.requestBody, |
| 45 | mediaType: 'application/json', |
| 46 | errors: { |
| 47 | 422: 'Validation Error' |
| 48 | } |
| 49 | }); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Read Item |
| 54 | * Get item by ID. |
| 55 | * @param data The data for the request. |
| 56 | * @param data.id |
| 57 | * @returns ItemPublic Successful Response |
| 58 | * @throws ApiError |
| 59 | */ |
| 60 | public static readItem(data: ItemsReadItemData): CancelablePromise<ItemsReadItemResponse> { |
| 61 | return __request(OpenAPI, { |
| 62 | method: 'GET', |
| 63 | url: '/api/v1/items/{id}', |
| 64 | path: { |
| 65 | id: data.id |
| 66 | }, |
| 67 | errors: { |
| 68 | 422: 'Validation Error' |
| 69 | } |
| 70 | }); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Update Item |
| 75 | * Update an item. |
| 76 | * @param data The data for the request. |
| 77 | * @param data.id |
| 78 | * @param data.requestBody |
| 79 | * @returns ItemPublic Successful Response |
| 80 | * @throws ApiError |
| 81 | */ |
| 82 | public static updateItem(data: ItemsUpdateItemData): CancelablePromise<ItemsUpdateItemResponse> { |
| 83 | return __request(OpenAPI, { |
| 84 | method: 'PUT', |
| 85 | url: '/api/v1/items/{id}', |
| 86 | path: { |
| 87 | id: data.id |
| 88 | }, |
| 89 | body: data.requestBody, |
| 90 | mediaType: 'application/json', |
| 91 | errors: { |
| 92 | 422: 'Validation Error' |
| 93 | } |
| 94 | }); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Delete Item |
| 99 | * Delete an item. |
| 100 | * @param data The data for the request. |
| 101 | * @param data.id |
| 102 | * @returns Message Successful Response |
| 103 | * @throws ApiError |
| 104 | */ |
| 105 | public static deleteItem(data: ItemsDeleteItemData): CancelablePromise<ItemsDeleteItemResponse> { |
| 106 | return __request(OpenAPI, { |
| 107 | method: 'DELETE', |
| 108 | url: '/api/v1/items/{id}', |
| 109 | path: { |
| 110 | id: data.id |
| 111 | }, |
| 112 | errors: { |
| 113 | 422: 'Validation Error' |
| 114 | } |
| 115 | }); |
| 116 | } |
| 117 | } |
| 118 | |
| 119 | export class LoginService { |
| 120 | /** |
| 121 | * Login Access Token |
| 122 | * OAuth2 compatible token login, get an access token for future requests |
| 123 | * @param data The data for the request. |
| 124 | * @param data.formData |
| 125 | * @returns Token Successful Response |
| 126 | * @throws ApiError |
| 127 | */ |
| 128 | public static loginAccessToken(data: LoginLoginAccessTokenData): CancelablePromise<LoginLoginAccessTokenResponse> { |
| 129 | return __request(OpenAPI, { |
| 130 | method: 'POST', |
| 131 | url: '/api/v1/login/access-token', |
| 132 | formData: data.formData, |
| 133 | mediaType: 'application/x-www-form-urlencoded', |
| 134 | errors: { |
| 135 | 422: 'Validation Error' |
| 136 | } |
| 137 | }); |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Test Token |
| 142 | * Test access token |
| 143 | * @returns UserPublic Successful Response |
| 144 | * @throws ApiError |
| 145 | */ |
| 146 | public static testToken(): CancelablePromise<LoginTestTokenResponse> { |
| 147 | return __request(OpenAPI, { |
| 148 | method: 'POST', |
| 149 | url: '/api/v1/login/test-token' |
| 150 | }); |
| 151 | } |
| 152 | |
| 153 | /** |
| 154 | * Recover Password |
| 155 | * Password Recovery |
| 156 | * @param data The data for the request. |
| 157 | * @param data.email |
| 158 | * @returns Message Successful Response |
| 159 | * @throws ApiError |
| 160 | */ |
| 161 | public static recoverPassword(data: LoginRecoverPasswordData): CancelablePromise<LoginRecoverPasswordResponse> { |
| 162 | return __request(OpenAPI, { |
| 163 | method: 'POST', |
| 164 | url: '/api/v1/password-recovery/{email}', |
| 165 | path: { |
| 166 | email: data.email |
| 167 | }, |
| 168 | errors: { |
| 169 | 422: 'Validation Error' |
| 170 | } |
| 171 | }); |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Reset Password |
| 176 | * Reset password |
| 177 | * @param data The data for the request. |
| 178 | * @param data.requestBody |
| 179 | * @returns Message Successful Response |
| 180 | * @throws ApiError |
| 181 | */ |
| 182 | public static resetPassword(data: LoginResetPasswordData): CancelablePromise<LoginResetPasswordResponse> { |
| 183 | return __request(OpenAPI, { |
| 184 | method: 'POST', |
| 185 | url: '/api/v1/reset-password/', |
| 186 | body: data.requestBody, |
| 187 | mediaType: 'application/json', |
| 188 | errors: { |
| 189 | 422: 'Validation Error' |
| 190 | } |
| 191 | }); |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Recover Password Html Content |
| 196 | * HTML Content for Password Recovery |
| 197 | * @param data The data for the request. |
| 198 | * @param data.email |
| 199 | * @returns string Successful Response |
| 200 | * @throws ApiError |
| 201 | */ |
| 202 | public static recoverPasswordHtmlContent(data: LoginRecoverPasswordHtmlContentData): CancelablePromise<LoginRecoverPasswordHtmlContentResponse> { |
| 203 | return __request(OpenAPI, { |
| 204 | method: 'POST', |
| 205 | url: '/api/v1/password-recovery-html-content/{email}', |
| 206 | path: { |
| 207 | email: data.email |
| 208 | }, |
| 209 | errors: { |
| 210 | 422: 'Validation Error' |
| 211 | } |
| 212 | }); |
| 213 | } |
| 214 | } |
| 215 | |
| 216 | export class PrivateService { |
| 217 | /** |
| 218 | * Create User |
| 219 | * Create a new user. |
| 220 | * @param data The data for the request. |
| 221 | * @param data.requestBody |
| 222 | * @returns UserPublic Successful Response |
| 223 | * @throws ApiError |
| 224 | */ |
| 225 | public static createUser(data: PrivateCreateUserData): CancelablePromise<PrivateCreateUserResponse> { |
| 226 | return __request(OpenAPI, { |
| 227 | method: 'POST', |
| 228 | url: '/api/v1/private/users/', |
| 229 | body: data.requestBody, |
| 230 | mediaType: 'application/json', |
| 231 | errors: { |
| 232 | 422: 'Validation Error' |
| 233 | } |
| 234 | }); |
| 235 | } |
| 236 | } |
| 237 | |
| 238 | export class UsersService { |
| 239 | /** |
| 240 | * Read Users |
| 241 | * Retrieve users. |
| 242 | * @param data The data for the request. |
| 243 | * @param data.skip |
| 244 | * @param data.limit |
| 245 | * @returns UsersPublic Successful Response |
| 246 | * @throws ApiError |
| 247 | */ |
| 248 | public static readUsers(data: UsersReadUsersData = {}): CancelablePromise<UsersReadUsersResponse> { |
| 249 | return __request(OpenAPI, { |
| 250 | method: 'GET', |
| 251 | url: '/api/v1/users/', |
| 252 | query: { |
| 253 | skip: data.skip, |
| 254 | limit: data.limit |
| 255 | }, |
| 256 | errors: { |
| 257 | 422: 'Validation Error' |
| 258 | } |
| 259 | }); |
| 260 | } |
| 261 | |
| 262 | /** |
| 263 | * Create User |
| 264 | * Create new user. |
| 265 | * @param data The data for the request. |
| 266 | * @param data.requestBody |
| 267 | * @returns UserPublic Successful Response |
| 268 | * @throws ApiError |
| 269 | */ |
| 270 | public static createUser(data: UsersCreateUserData): CancelablePromise<UsersCreateUserResponse> { |
| 271 | return __request(OpenAPI, { |
| 272 | method: 'POST', |
| 273 | url: '/api/v1/users/', |
| 274 | body: data.requestBody, |
| 275 | mediaType: 'application/json', |
| 276 | errors: { |
| 277 | 422: 'Validation Error' |
| 278 | } |
| 279 | }); |
| 280 | } |
| 281 | |
| 282 | /** |
| 283 | * Read User Me |
| 284 | * Get current user. |
| 285 | * @returns UserPublic Successful Response |
| 286 | * @throws ApiError |
| 287 | */ |
| 288 | public static readUserMe(): CancelablePromise<UsersReadUserMeResponse> { |
| 289 | return __request(OpenAPI, { |
| 290 | method: 'GET', |
| 291 | url: '/api/v1/users/me' |
| 292 | }); |
| 293 | } |
| 294 | |
| 295 | /** |
| 296 | * Delete User Me |
| 297 | * Delete own user. |
| 298 | * @returns Message Successful Response |
| 299 | * @throws ApiError |
| 300 | */ |
| 301 | public static deleteUserMe(): CancelablePromise<UsersDeleteUserMeResponse> { |
| 302 | return __request(OpenAPI, { |
| 303 | method: 'DELETE', |
| 304 | url: '/api/v1/users/me' |
| 305 | }); |
| 306 | } |
| 307 | |
| 308 | /** |
| 309 | * Update User Me |
| 310 | * Update own user. |
| 311 | * @param data The data for the request. |
| 312 | * @param data.requestBody |
| 313 | * @returns UserPublic Successful Response |
| 314 | * @throws ApiError |
| 315 | */ |
| 316 | public static updateUserMe(data: UsersUpdateUserMeData): CancelablePromise<UsersUpdateUserMeResponse> { |
| 317 | return __request(OpenAPI, { |
| 318 | method: 'PATCH', |
| 319 | url: '/api/v1/users/me', |
| 320 | body: data.requestBody, |
| 321 | mediaType: 'application/json', |
| 322 | errors: { |
| 323 | 422: 'Validation Error' |
| 324 | } |
| 325 | }); |
| 326 | } |
| 327 | |
| 328 | /** |
| 329 | * Update Password Me |
| 330 | * Update own password. |
| 331 | * @param data The data for the request. |
| 332 | * @param data.requestBody |
| 333 | * @returns Message Successful Response |
| 334 | * @throws ApiError |
| 335 | */ |
| 336 | public static updatePasswordMe(data: UsersUpdatePasswordMeData): CancelablePromise<UsersUpdatePasswordMeResponse> { |
| 337 | return __request(OpenAPI, { |
| 338 | method: 'PATCH', |
| 339 | url: '/api/v1/users/me/password', |
| 340 | body: data.requestBody, |
| 341 | mediaType: 'application/json', |
| 342 | errors: { |
| 343 | 422: 'Validation Error' |
| 344 | } |
| 345 | }); |
| 346 | } |
| 347 | |
| 348 | /** |
| 349 | * Register User |
| 350 | * Create new user without the need to be logged in. |
| 351 | * @param data The data for the request. |
| 352 | * @param data.requestBody |
| 353 | * @returns UserPublic Successful Response |
| 354 | * @throws ApiError |
| 355 | */ |
| 356 | public static registerUser(data: UsersRegisterUserData): CancelablePromise<UsersRegisterUserResponse> { |
| 357 | return __request(OpenAPI, { |
| 358 | method: 'POST', |
| 359 | url: '/api/v1/users/signup', |
| 360 | body: data.requestBody, |
| 361 | mediaType: 'application/json', |
| 362 | errors: { |
| 363 | 422: 'Validation Error' |
| 364 | } |
| 365 | }); |
| 366 | } |
| 367 | |
| 368 | /** |
| 369 | * Read User By Id |
| 370 | * Get a specific user by id. |
| 371 | * @param data The data for the request. |
| 372 | * @param data.userId |
| 373 | * @returns UserPublic Successful Response |
| 374 | * @throws ApiError |
| 375 | */ |
| 376 | public static readUserById(data: UsersReadUserByIdData): CancelablePromise<UsersReadUserByIdResponse> { |
| 377 | return __request(OpenAPI, { |
| 378 | method: 'GET', |
| 379 | url: '/api/v1/users/{user_id}', |
| 380 | path: { |
| 381 | user_id: data.userId |
| 382 | }, |
| 383 | errors: { |
| 384 | 422: 'Validation Error' |
| 385 | } |
| 386 | }); |
| 387 | } |
| 388 | |
| 389 | /** |
| 390 | * Update User |
| 391 | * Update a user. |
| 392 | * @param data The data for the request. |
| 393 | * @param data.userId |
| 394 | * @param data.requestBody |
| 395 | * @returns UserPublic Successful Response |
| 396 | * @throws ApiError |
| 397 | */ |
| 398 | public static updateUser(data: UsersUpdateUserData): CancelablePromise<UsersUpdateUserResponse> { |
| 399 | return __request(OpenAPI, { |
| 400 | method: 'PATCH', |
| 401 | url: '/api/v1/users/{user_id}', |
| 402 | path: { |
| 403 | user_id: data.userId |
| 404 | }, |
| 405 | body: data.requestBody, |
| 406 | mediaType: 'application/json', |
| 407 | errors: { |
| 408 | 422: 'Validation Error' |
| 409 | } |
| 410 | }); |
| 411 | } |
| 412 | |
| 413 | /** |
| 414 | * Delete User |
| 415 | * Delete a user. |
| 416 | * @param data The data for the request. |
| 417 | * @param data.userId |
| 418 | * @returns Message Successful Response |
| 419 | * @throws ApiError |
| 420 | */ |
| 421 | public static deleteUser(data: UsersDeleteUserData): CancelablePromise<UsersDeleteUserResponse> { |
| 422 | return __request(OpenAPI, { |
| 423 | method: 'DELETE', |
| 424 | url: '/api/v1/users/{user_id}', |
| 425 | path: { |
| 426 | user_id: data.userId |
| 427 | }, |
| 428 | errors: { |
| 429 | 422: 'Validation Error' |
| 430 | } |
| 431 | }); |
| 432 | } |
| 433 | } |
| 434 | |
| 435 | export class UtilsService { |
| 436 | /** |
| 437 | * Test Email |
| 438 | * Test emails. |
| 439 | * @param data The data for the request. |
| 440 | * @param data.emailTo |
| 441 | * @returns Message Successful Response |
| 442 | * @throws ApiError |
| 443 | */ |
| 444 | public static testEmail(data: UtilsTestEmailData): CancelablePromise<UtilsTestEmailResponse> { |
| 445 | return __request(OpenAPI, { |
| 446 | method: 'POST', |
| 447 | url: '/api/v1/utils/test-email/', |
| 448 | query: { |
| 449 | email_to: data.emailTo |
| 450 | }, |
| 451 | errors: { |
| 452 | 422: 'Validation Error' |
| 453 | } |
| 454 | }); |
| 455 | } |
| 456 | |
| 457 | /** |
| 458 | * Health Check |
| 459 | * @returns boolean Successful Response |
| 460 | * @throws ApiError |
| 461 | */ |
| 462 | public static healthCheck(): CancelablePromise<UtilsHealthCheckResponse> { |
| 463 | return __request(OpenAPI, { |
| 464 | method: 'GET', |
| 465 | url: '/api/v1/utils/health-check/' |
| 466 | }); |
| 467 | } |
| 468 | } |