https://github.com/techcell-project/tech-cell-server-dart-dio-sdk
https://github.com/techcell-project/tech-cell-server-dart-dio-sdk
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/techcell-project/tech-cell-server-dart-dio-sdk
- Owner: TechCell-Project
- Created: 2023-12-15T12:03:23.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-17T14:39:08.000Z (over 2 years ago)
- Last Synced: 2023-12-17T17:50:04.385Z (over 2 years ago)
- Language: Dart
- Size: 108 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openapi (EXPERIMENTAL)
This is the documentation for the TechCell RESTful API.
You can change the language by setting the header (`x-lang`, `x-language`) or by using a query (`lang`, `language`).
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.0.1
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
For more information, please visit [https://techcell.cloud](https://techcell.cloud)
## Requirements
* Dart 2.15.0+ or Flutter 2.8.0+
* Dio 5.0.0+ (https://pub.dev/packages/dio)
## Installation & Usage
### pub.dev
To use the package from [pub.dev](https://pub.dev), please include the following in pubspec.yaml
```yaml
dependencies:
openapi: 1.0.0
```
### Github
If this Dart package is published to Github, please include the following in pubspec.yaml
```yaml
dependencies:
openapi:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
```
### Local development
To use the package from your local drive, please include the following in pubspec.yaml
```yaml
dependencies:
openapi:
path: /path/to/openapi
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```dart
import 'package:openapi/openapi.dart';
final api = Openapi().getAddressApi();
final num provinceId = 201; // num | Mã tỉnh thành
final String xLang = en; // String | The language of the response
try {
final response = await api.getDistricts(provinceId, xLang);
print(response);
} catch on DioException (e) {
print("Exception when calling AddressApi->getDistricts: $e\n");
}
```
## Documentation for API Endpoints
All URIs are relative to *https://api.techcell.cloud*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
[*AddressApi*](doc/AddressApi.md) | [**getDistricts**](doc/AddressApi.md#getdistricts) | **GET** /address/districts/{province_id} | Get districts
[*AddressApi*](doc/AddressApi.md) | [**getProvinces**](doc/AddressApi.md#getprovinces) | **GET** /address/provinces | Get provinces
[*AddressApi*](doc/AddressApi.md) | [**getWards**](doc/AddressApi.md#getwards) | **GET** /address/wards/{district_id} | Get wards
[*AttributesApi*](doc/AttributesApi.md) | [**createAttribute**](doc/AttributesApi.md#createattribute) | **POST** /attributes | Create attribute
[*AttributesApi*](doc/AttributesApi.md) | [**deleteAttribute**](doc/AttributesApi.md#deleteattribute) | **DELETE** /attributes/{attributeId} | Delete attribute
[*AttributesApi*](doc/AttributesApi.md) | [**getAttributeById**](doc/AttributesApi.md#getattributebyid) | **GET** /attributes/{attributeId} | Get attribute by id
[*AttributesApi*](doc/AttributesApi.md) | [**getAttributes**](doc/AttributesApi.md#getattributes) | **GET** /attributes | Get list of attribute
[*AttributesApi*](doc/AttributesApi.md) | [**getAttributesByLabel**](doc/AttributesApi.md#getattributesbylabel) | **GET** /attributes/label/{label} | Get attribute by label
[*AttributesApi*](doc/AttributesApi.md) | [**updateAttributeInfo**](doc/AttributesApi.md#updateattributeinfo) | **PATCH** /attributes/{attributeId} | Update attribute
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**changePassword**](doc/AuthenticationApi.md#changepassword) | **POST** /auth/change-password | Change password
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**checkEmail**](doc/AuthenticationApi.md#checkemail) | **POST** /auth/check-email | Check email is exist or not
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**forgotPassword**](doc/AuthenticationApi.md#forgotpassword) | **POST** /auth/forgot-password | Forgot password
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**getNewToken**](doc/AuthenticationApi.md#getnewtoken) | **POST** /auth/refresh-token | Get new token
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**google**](doc/AuthenticationApi.md#google) | **POST** /auth/google | Login with google
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**login**](doc/AuthenticationApi.md#login) | **POST** /auth/login | Login
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**register**](doc/AuthenticationApi.md#register) | **POST** /auth/register | Register new user
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**resendVerifyEmailOtp**](doc/AuthenticationApi.md#resendverifyemailotp) | **POST** /auth/resend-verify-email-otp | Resend verify email otp
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**verifyEmail**](doc/AuthenticationApi.md#verifyemail) | **POST** /auth/verify-email | Verify email registration
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**verifyForgotPassword**](doc/AuthenticationApi.md#verifyforgotpassword) | **POST** /auth/verify-forgot-password | Verify forgot password
[*CartsApi*](doc/CartsApi.md) | [**addCart**](doc/CartsApi.md#addcart) | **POST** /carts | Add/update cart
[*CartsApi*](doc/CartsApi.md) | [**deleteProductsCart**](doc/CartsApi.md#deleteproductscart) | **DELETE** /carts | Delete products cart
[*CartsApi*](doc/CartsApi.md) | [**getCarts**](doc/CartsApi.md#getcarts) | **GET** /carts | Get list of carts
[*CategoriesApi*](doc/CategoriesApi.md) | [**createCategory**](doc/CategoriesApi.md#createcategory) | **POST** /categories | Create category
[*CategoriesApi*](doc/CategoriesApi.md) | [**getCategories**](doc/CategoriesApi.md#getcategories) | **GET** /categories | Get list of categories
[*CategoriesApi*](doc/CategoriesApi.md) | [**getCategoryById**](doc/CategoriesApi.md#getcategorybyid) | **GET** /categories/{categoryId} | Get category by id
[*CategoriesApi*](doc/CategoriesApi.md) | [**getCategoryByLabel**](doc/CategoriesApi.md#getcategorybylabel) | **GET** /categories/label/{label} | Get category by label
[*CategoriesApi*](doc/CategoriesApi.md) | [**updateCategory**](doc/CategoriesApi.md#updatecategory) | **PATCH** /categories/{categoryId} | Update category
[*HealthApi*](doc/HealthApi.md) | [**readiness**](doc/HealthApi.md#readiness) | **GET** /health | Health check
[*ImagesApi*](doc/ImagesApi.md) | [**getImageByPublicId**](doc/ImagesApi.md#getimagebypublicid) | **GET** /images/{publicId} | Get image by public id
[*ImagesApi*](doc/ImagesApi.md) | [**uploadArrayImages**](doc/ImagesApi.md#uploadarrayimages) | **POST** /images/array | Upload array of image
[*ImagesApi*](doc/ImagesApi.md) | [**uploadSingleImage**](doc/ImagesApi.md#uploadsingleimage) | **POST** /images | Upload image
[*NotificationsApi*](doc/NotificationsApi.md) | [**getUserNotifications**](doc/NotificationsApi.md#getusernotifications) | **GET** /notifications | Get notifications's user
[*OrderApi*](doc/OrderApi.md) | [**createOrder**](doc/OrderApi.md#createorder) | **POST** /order | Create a order
[*OrderApi*](doc/OrderApi.md) | [**getAllUserOrders**](doc/OrderApi.md#getalluserorders) | **GET** /order | Get all order's user
[*OrderApi*](doc/OrderApi.md) | [**reviewOrder**](doc/OrderApi.md#revieworder) | **POST** /order/review | Review a order
[*OrdersManagementApi*](doc/OrdersManagementApi.md) | [**getOrder**](doc/OrdersManagementApi.md#getorder) | **GET** /orders-mnt/{id} | Get order by id
[*OrdersManagementApi*](doc/OrdersManagementApi.md) | [**getOrders**](doc/OrdersManagementApi.md#getorders) | **GET** /orders-mnt | Get orders
[*OrdersManagementApi*](doc/OrdersManagementApi.md) | [**updateOrderStatus**](doc/OrdersManagementApi.md#updateorderstatus) | **PATCH** /orders-mnt/{id} | Update order status
[*ProductsApi*](doc/ProductsApi.md) | [**createProduct**](doc/ProductsApi.md#createproduct) | **POST** /products | Create a new product
[*ProductsApi*](doc/ProductsApi.md) | [**deleteProduct**](doc/ProductsApi.md#deleteproduct) | **DELETE** /products/{productId} | Delete product by id
[*ProductsApi*](doc/ProductsApi.md) | [**deleteProductVariation**](doc/ProductsApi.md#deleteproductvariation) | **DELETE** /products/{productId}/{sku} | Delete product variation
[*ProductsApi*](doc/ProductsApi.md) | [**getProductById**](doc/ProductsApi.md#getproductbyid) | **GET** /products/{productId} | Get product by id
[*ProductsApi*](doc/ProductsApi.md) | [**getProducts**](doc/ProductsApi.md#getproducts) | **GET** /products | Get products list
[*ProductsApi*](doc/ProductsApi.md) | [**updateProduct**](doc/ProductsApi.md#updateproduct) | **PUT** /products/{productId} | Update product by id
[*ProfileApi*](doc/ProfileApi.md) | [**getProfile**](doc/ProfileApi.md#getprofile) | **GET** /profile | Get current user info
[*ProfileApi*](doc/ProfileApi.md) | [**updateUserAddress**](doc/ProfileApi.md#updateuseraddress) | **PATCH** /profile/address | Update current user address
[*ProfileApi*](doc/ProfileApi.md) | [**updateUserInfo**](doc/ProfileApi.md#updateuserinfo) | **PATCH** /profile/info | Update current user info
[*StatsApi*](doc/StatsApi.md) | [**getStats**](doc/StatsApi.md#getstats) | **GET** /stats | Get stats in a period of time
[*UsersManagementApi*](doc/UsersManagementApi.md) | [**blockUser**](doc/UsersManagementApi.md#blockuser) | **PATCH** /users/{id}/block | Block user
[*UsersManagementApi*](doc/UsersManagementApi.md) | [**changeRoleUser**](doc/UsersManagementApi.md#changeroleuser) | **PATCH** /users/{id}/change-role | Change role user
[*UsersManagementApi*](doc/UsersManagementApi.md) | [**createUser**](doc/UsersManagementApi.md#createuser) | **POST** /users | Create new user
[*UsersManagementApi*](doc/UsersManagementApi.md) | [**getUserById**](doc/UsersManagementApi.md#getuserbyid) | **GET** /users/{id} | Get user by id
[*UsersManagementApi*](doc/UsersManagementApi.md) | [**getUsers**](doc/UsersManagementApi.md#getusers) | **GET** /users | Get list of users
[*UsersManagementApi*](doc/UsersManagementApi.md) | [**unblockUser**](doc/UsersManagementApi.md#unblockuser) | **PATCH** /users/{id}/unblock | Unblock user
## Documentation For Models
- [AddCartRequestDTO](doc/AddCartRequestDTO.md)
- [AddressSchemaDTO](doc/AddressSchemaDTO.md)
- [AttributeDTO](doc/AttributeDTO.md)
- [BlockActivitySchemaDTO](doc/BlockActivitySchemaDTO.md)
- [BlockSchemaDTO](doc/BlockSchemaDTO.md)
- [BlockUnblockRequestDTO](doc/BlockUnblockRequestDTO.md)
- [CategoryDTO](doc/CategoryDTO.md)
- [CategoryIdDTO](doc/CategoryIdDTO.md)
- [ChangePasswordRequestDTO](doc/ChangePasswordRequestDTO.md)
- [ChangeRoleRequestDTO](doc/ChangeRoleRequestDTO.md)
- [CheckoutOrderSchemaDTO](doc/CheckoutOrderSchemaDTO.md)
- [CreateAttributeRequestDTO](doc/CreateAttributeRequestDTO.md)
- [CreateCategoryRequestDTO](doc/CreateCategoryRequestDTO.md)
- [CreateOrderRequestDTO](doc/CreateOrderRequestDTO.md)
- [CreateProductRequestDTO](doc/CreateProductRequestDTO.md)
- [CreateUserRequestDto](doc/CreateUserRequestDto.md)
- [DeleteProductsCartRequestDTO](doc/DeleteProductsCartRequestDTO.md)
- [DistrictSchemaDTO](doc/DistrictSchemaDTO.md)
- [EmailRequestDTO](doc/EmailRequestDTO.md)
- [ForgotPasswordDTO](doc/ForgotPasswordDTO.md)
- [GetCartResponseDTO](doc/GetCartResponseDTO.md)
- [GetOrderByIdResponseDTO](doc/GetOrderByIdResponseDTO.md)
- [GetStatsDataDTO](doc/GetStatsDataDTO.md)
- [GetStatsResponseDTO](doc/GetStatsResponseDTO.md)
- [GhnDistrictDTO](doc/GhnDistrictDTO.md)
- [GhnProvinceDTO](doc/GhnProvinceDTO.md)
- [GhnWardDTO](doc/GhnWardDTO.md)
- [GoogleLoginRequestDTO](doc/GoogleLoginRequestDTO.md)
- [ImageRequestDTO](doc/ImageRequestDTO.md)
- [ImageSchemaDTO](doc/ImageSchemaDTO.md)
- [ImageUploadedResponseDTO](doc/ImageUploadedResponseDTO.md)
- [ListAttributeResponseDTO](doc/ListAttributeResponseDTO.md)
- [ListCategoryResponseDTO](doc/ListCategoryResponseDTO.md)
- [ListNotificationsResponseDTO](doc/ListNotificationsResponseDTO.md)
- [ListOrderResponseDTO](doc/ListOrderResponseDTO.md)
- [ListProductResponseDTO](doc/ListProductResponseDTO.md)
- [ListUserResponseDTO](doc/ListUserResponseDTO.md)
- [LoginRequestDTO](doc/LoginRequestDTO.md)
- [NewTokenRequestDTO](doc/NewTokenRequestDTO.md)
- [NotificationsDTO](doc/NotificationsDTO.md)
- [OrderSchemaDTO](doc/OrderSchemaDTO.md)
- [PaymentOrderDTO](doc/PaymentOrderDTO.md)
- [PriceDTO](doc/PriceDTO.md)
- [ProductAttributeDTO](doc/ProductAttributeDTO.md)
- [ProductCartDTO](doc/ProductCartDTO.md)
- [ProductCartSchemaDTO](doc/ProductCartSchemaDTO.md)
- [ProductDTO](doc/ProductDTO.md)
- [ProductImageDTO](doc/ProductImageDTO.md)
- [ProductOrderSchemaDTO](doc/ProductOrderSchemaDTO.md)
- [ProductPriceDTO](doc/ProductPriceDTO.md)
- [ProductVariationDTO](doc/ProductVariationDTO.md)
- [ProductsOrder](doc/ProductsOrder.md)
- [ProvinceSchemaDTO](doc/ProvinceSchemaDTO.md)
- [Readiness200Response](doc/Readiness200Response.md)
- [Readiness200ResponseInfoValue](doc/Readiness200ResponseInfoValue.md)
- [Readiness503Response](doc/Readiness503Response.md)
- [RegisterRequestDTO](doc/RegisterRequestDTO.md)
- [ReviewOrderRequestDTO](doc/ReviewOrderRequestDTO.md)
- [ReviewedOrderResponseDTO](doc/ReviewedOrderResponseDTO.md)
- [SelectProduct](doc/SelectProduct.md)
- [ShippingOrderSchemaDTO](doc/ShippingOrderSchemaDTO.md)
- [UpdateAttributeRequestDTO](doc/UpdateAttributeRequestDTO.md)
- [UpdateCategoryRequestDTO](doc/UpdateCategoryRequestDTO.md)
- [UpdateOrderStatusDTO](doc/UpdateOrderStatusDTO.md)
- [UpdateProductRequestDTO](doc/UpdateProductRequestDTO.md)
- [UpdateUserAddressRequestDTO](doc/UpdateUserAddressRequestDTO.md)
- [UpdateUserRequestDTO](doc/UpdateUserRequestDTO.md)
- [UserDataResponseDTO](doc/UserDataResponseDTO.md)
- [UserMntResponseDTO](doc/UserMntResponseDTO.md)
- [VariationRequestDTO](doc/VariationRequestDTO.md)
- [VerifyEmailRequestDTO](doc/VerifyEmailRequestDTO.md)
- [VerifyForgotPasswordDTO](doc/VerifyForgotPasswordDTO.md)
- [WardSchemaDTO](doc/WardSchemaDTO.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### accessToken
- **Type**: HTTP Bearer Token authentication (Bearer)
## Author
teams@techcell.cloud