Files
we_pro_dock/FRONTEND/API/TENANT.md
2024-05-14 11:39:33 +03:00

1.7 KiB
Raw Blame History

Импорт константы API_BASE_URL из файла constants:

import { API_BASE_URL } from '~/constants'

Импорт путей API из файла openapi.gen:

import type { paths } from '~/openapi.gen'

Типы ответов на запросы к API для получения арендаторов и арендатора по ID:

export type GetTenantsResponse =
  paths['/tenants']['get']['responses']['200']['content']['application/json'];
export type GetTenantResponse =
  paths['/tenants/{id}']['get']['responses']['200']['content']['application/json'];

Типы запросов для создания и обновления арендатора:

type CreateTenantRequest =
  paths['/tenants']['post']['requestBody']['content']['application/json'];
type UpdateTenantRequest =
  paths['/tenants/{id}']['put']['requestBody']['content']['application/json'];

Типы ответа при создании и обновлении арендатора:

export type CreateTenantResponse =
  paths['/tenants']['post']['responses']['201']['content']['application/json'];
export type UpdateTenantResponse =
  paths['/tenants/{id}']['put']['responses']['200']['content']['application/json'];

Функции для работы с арендаторами и их контактами:

  • createTenant: Функция для создания нового арендатора.
  • updateTenant: Функция для обновления данных арендатора.
  • removeTenant: Функция для удаления арендатора.
  • createTenantContact: Функция для добавления контакта к арендатору.