@my-market/contracts 0.0.2

package/docs/ProductsApi.md

@@ -0,0 +1,348 @@
+# ProductsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**productsControllerCreate**](#productscontrollercreate) | **POST** /products | Создать товар|
+|[**productsControllerFindAll**](#productscontrollerfindall) | **GET** /products | Получить список товаров по складу? с пагинацией|
+|[**productsControllerFindOne**](#productscontrollerfindone) | **GET** /products/{id} | Получить товар по ID|
+|[**productsControllerRemove**](#productscontrollerremove) | **DELETE** /products/{id} | Удалить товар|
+|[**productsControllerSearch**](#productscontrollersearch) | **GET** /products/search | Поиск товаров|
+|[**productsControllerUpdate**](#productscontrollerupdate) | **PATCH** /products/{id} | Обновить товар|
+
+# **productsControllerCreate**
+> object productsControllerCreate(createProductDto)
+
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    CreateProductDto
+} from '@my-market-contracts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let createProductDto: CreateProductDto; //
+
+const { status, data } = await apiInstance.productsControllerCreate(
+    createProductDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createProductDto** | **CreateProductDto**|  | |
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+|**400** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **productsControllerFindAll**
+> Array<object> productsControllerFindAll()
+
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@my-market-contracts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let warehouseId: number; //ID склада (optional) (default to undefined)
+let page: number; //Номер страницы для пагинации (optional) (default to undefined)
+let limit: number; //Количество элементов на странице (optional) (default to 50)
+
+const { status, data } = await apiInstance.productsControllerFindAll(
+    warehouseId,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **warehouseId** | [**number**] | ID склада | (optional) defaults to undefined|
+| **page** | [**number**] | Номер страницы для пагинации | (optional) defaults to undefined|
+| **limit** | [**number**] | Количество элементов на странице | (optional) defaults to 50|
+
+
+### Return type
+
+**Array<object>**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **productsControllerFindOne**
+> object productsControllerFindOne()
+
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@my-market-contracts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let id: number; // (default to undefined)
+
+const { status, data } = await apiInstance.productsControllerFindOne(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **productsControllerRemove**
+> productsControllerRemove()
+
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@my-market-contracts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let id: number; //ID товара (default to undefined)
+
+const { status, data } = await apiInstance.productsControllerRemove(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | ID товара | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **productsControllerSearch**
+> Array<object> productsControllerSearch()
+
+Поиск товаров по названию, штрихкоду или артикулу
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@my-market-contracts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let text: string; //Значение поиска (optional) (default to undefined)
+let sort: string; //Поле сортировки (optional) (default to undefined)
+let order: string; //Тип сортировки (optional) (default to undefined)
+let page: number; //Номер страницы для пагинации (optional) (default to undefined)
+let limit: number; //Количество элементов на странице (optional) (default to 50)
+
+const { status, data } = await apiInstance.productsControllerSearch(
+    text,
+    sort,
+    order,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **text** | [**string**] | Значение поиска | (optional) defaults to undefined|
+| **sort** | [**string**] | Поле сортировки | (optional) defaults to undefined|
+| **order** | [**string**] | Тип сортировки | (optional) defaults to undefined|
+| **page** | [**number**] | Номер страницы для пагинации | (optional) defaults to undefined|
+| **limit** | [**number**] | Количество элементов на странице | (optional) defaults to 50|
+
+
+### Return type
+
+**Array<object>**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **productsControllerUpdate**
+> object productsControllerUpdate(updateProductDto)
+
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    UpdateProductDto
+} from '@my-market-contracts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let id: number; //ID товара (default to undefined)
+let updateProductDto: UpdateProductDto; //
+
+const { status, data } = await apiInstance.productsControllerUpdate(
+    id,
+    updateProductDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateProductDto** | **UpdateProductDto**|  | |
+| **id** | [**number**] | ID товара | defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/RegisterEmployeeDto.md

@@ -0,0 +1,26 @@
+# RegisterEmployeeDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | ФИО владельца | [default to undefined]
+**email** | **string** | Email адрес | [default to undefined]
+**password** | **string** | Пароль | [default to undefined]
+**invitationCode** | **string** | Реферальный код | [default to undefined]
+
+## Example
+
+```typescript
+import { RegisterEmployeeDto } from '@my-market-contracts';
+
+const instance: RegisterEmployeeDto = {
+    name,
+    email,
+    password,
+    invitationCode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RegisterOwnerDto.md

@@ -0,0 +1,26 @@
+# RegisterOwnerDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | ФИО владельца | [default to undefined]
+**email** | **string** | Email адрес | [default to undefined]
+**password** | **string** | Пароль | [default to undefined]
+**businessName** | **string** | Название бизнеса | [default to undefined]
+
+## Example
+
+```typescript
+import { RegisterOwnerDto } from '@my-market-contracts';
+
+const instance: RegisterOwnerDto = {
+    name,
+    email,
+    password,
+    businessName,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ResetPasswordDto.md

@@ -0,0 +1,22 @@
+# ResetPasswordDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** | Токен сброса пароля | [default to undefined]
+**newPassword** | **string** | Новый пароль | [default to undefined]
+
+## Example
+
+```typescript
+import { ResetPasswordDto } from '@my-market-contracts';
+
+const instance: ResetPasswordDto = {
+    token,
+    newPassword,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SellItemDto.md

@@ -0,0 +1,24 @@
+# SellItemDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**warehouseId** | **number** | ID склада | [default to undefined]
+**productId** | **number** | ID товара | [default to undefined]
+**quantity** | **number** | Количество | [default to undefined]
+
+## Example
+
+```typescript
+import { SellItemDto } from '@my-market-contracts';
+
+const instance: SellItemDto = {
+    warehouseId,
+    productId,
+    quantity,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SellProductDto.md

@@ -0,0 +1,20 @@
+# SellProductDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<SellItemDto>**](SellItemDto.md) | Список товаров для продажи (можно передать 1 товар или несколько) | [default to undefined]
+
+## Example
+
+```typescript
+import { SellProductDto } from '@my-market-contracts';
+
+const instance: SellProductDto = {
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateProductDto.md

@@ -0,0 +1,44 @@
+# UpdateProductDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Название товара | [optional] [default to undefined]
+**articleNumber** | **string** | Артикул товара | [optional] [default to undefined]
+**unitOfMeasurement** | **string** | Единица измерения | [optional] [default to undefined]
+**barcode** | **string** | Штрих-код товара | [optional] [default to undefined]
+**country** | **string** | Страна производства | [optional] [default to undefined]
+**vendor** | **string** | Производитель | [optional] [default to undefined]
+**salePrice** | **number** | Цена продажи | [optional] [default to undefined]
+**costPrice** | **number** | Себестоимость | [optional] [default to undefined]
+**purchasePrice** | **number** | Цена закупки | [optional] [default to undefined]
+**discount** | **number** | Скидка в процентах | [optional] [default to 0]
+**minimumBalance** | **number** | Минимальный остаток | [optional] [default to undefined]
+**description** | **string** | Описание товара | [optional] [default to undefined]
+**location** | **string** | Местоположение на складе | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductDto } from '@my-market-contracts';
+
+const instance: UpdateProductDto = {
+    name,
+    articleNumber,
+    unitOfMeasurement,
+    barcode,
+    country,
+    vendor,
+    salePrice,
+    costPrice,
+    purchasePrice,
+    discount,
+    minimumBalance,
+    description,
+    location,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)