https://github.com/techcell-project/dart-dio-sdk

A generated SDK for Dart-dio
https://github.com/techcell-project/dart-dio-sdk
Last synced: 8 months ago
JSON representation
A generated SDK for Dart-dio
Host: GitHub
URL: https://github.com/techcell-project/dart-dio-sdk
Owner: TechCell-Project
Created: 2024-04-06T18:23:39.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2024-04-13T18:21:22.000Z (about 2 years ago)
Last Synced: 2024-04-14T08:51:29.178Z (about 2 years ago)
Language: Dart
Homepage:
Size: 86.9 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

          # dart_dio_sdk (EXPERIMENTAL)

The documentations of the TechCell RESTful API

This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0

- Generator version: 7.4.0

- 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:

  dart_dio_sdk: 1.0.0

```

### Github

If this Dart package is published to Github, please include the following in pubspec.yaml

```yaml

dependencies:

  dart_dio_sdk:

    git:

      url: https://github.com/TechCell-Project/dart-dio-sdk.git

      #ref: main

```

### Local development

To use the package from your local drive, please include the following in pubspec.yaml

```yaml

dependencies:

  dart_dio_sdk:

    path: /path/to/dart_dio_sdk

```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```dart

import 'package:dart_dio_sdk/dart_dio_sdk.dart';

final api = DartDioSdk().getAddressApi();

final num provinceId = 201; // num | Mã tỉnh thành

try {

    final response = await api.addressControllerGetDistricts(provinceId);

    print(response);

} catch on DioException (e) {

    print("Exception when calling AddressApi->addressControllerGetDistricts: $e\n");

}

```

## Documentation for API Endpoints

All URIs are relative to *https://api.techcell.cloud*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

[*AddressApi*](doc/AddressApi.md) | [**addressControllerGetDistricts**](doc/AddressApi.md#addresscontrollergetdistricts) | **GET** /api/address/districts/{province_id} | Get districts

[*AddressApi*](doc/AddressApi.md) | [**addressControllerGetProvinces**](doc/AddressApi.md#addresscontrollergetprovinces) | **GET** /api/address/provinces | Get provinces

[*AddressApi*](doc/AddressApi.md) | [**addressControllerGetWards**](doc/AddressApi.md#addresscontrollergetwards) | **GET** /api/address/wards/{district_id} | Get wards

[*AttributesApi*](doc/AttributesApi.md) | [**attributesControllerCreateAttribute**](doc/AttributesApi.md#attributescontrollercreateattribute) | **POST** /api/attributes | 

[*AttributesApi*](doc/AttributesApi.md) | [**attributesControllerDeleteAttribute**](doc/AttributesApi.md#attributescontrollerdeleteattribute) | **DELETE** /api/attributes/{id} | 

[*AttributesApi*](doc/AttributesApi.md) | [**attributesControllerGetAttribute**](doc/AttributesApi.md#attributescontrollergetattribute) | **GET** /api/attributes/{id} | 

[*AttributesApi*](doc/AttributesApi.md) | [**attributesControllerGetAttributes**](doc/AttributesApi.md#attributescontrollergetattributes) | **GET** /api/attributes | 

[*AttributesApi*](doc/AttributesApi.md) | [**attributesControllerUpdateAttribute**](doc/AttributesApi.md#attributescontrollerupdateattribute) | **PATCH** /api/attributes/{id} | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerConfirmEmail**](doc/AuthApi.md#authcontrollerconfirmemail) | **POST** /api/auth/email/confirm | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerForgotPassword**](doc/AuthApi.md#authcontrollerforgotpassword) | **POST** /api/auth/forgot/password | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerGetMe**](doc/AuthApi.md#authcontrollergetme) | **GET** /api/auth/me | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerLogin**](doc/AuthApi.md#authcontrollerlogin) | **POST** /api/auth/email/login | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerLogout**](doc/AuthApi.md#authcontrollerlogout) | **POST** /api/auth/logout | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerRefresh**](doc/AuthApi.md#authcontrollerrefresh) | **POST** /api/auth/refresh | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerRegister**](doc/AuthApi.md#authcontrollerregister) | **POST** /api/auth/email/register | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerResendConfirmEmail**](doc/AuthApi.md#authcontrollerresendconfirmemail) | **POST** /api/auth/email/resend-confirm | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerResetPassword**](doc/AuthApi.md#authcontrollerresetpassword) | **POST** /api/auth/reset/password | 

[*AuthApi*](doc/AuthApi.md) | [**authControllerUpdateMe**](doc/AuthApi.md#authcontrollerupdateme) | **PATCH** /api/auth/me | 

[*AuthApi*](doc/AuthApi.md) | [**authFacebookControllerLogin**](doc/AuthApi.md#authfacebookcontrollerlogin) | **POST** /api/auth/facebook/login | 

[*AuthApi*](doc/AuthApi.md) | [**authGoogleControllerLogin**](doc/AuthApi.md#authgooglecontrollerlogin) | **POST** /api/auth/google/login | 

[*BrandsApi*](doc/BrandsApi.md) | [**brandsControllerCreateBrand**](doc/BrandsApi.md#brandscontrollercreatebrand) | **POST** /api/brands | 

[*BrandsApi*](doc/BrandsApi.md) | [**brandsControllerDeleteBrand**](doc/BrandsApi.md#brandscontrollerdeletebrand) | **DELETE** /api/brands/{id} | 

[*BrandsApi*](doc/BrandsApi.md) | [**brandsControllerGetBrand**](doc/BrandsApi.md#brandscontrollergetbrand) | **GET** /api/brands/{id} | 

[*BrandsApi*](doc/BrandsApi.md) | [**brandsControllerGetBrands**](doc/BrandsApi.md#brandscontrollergetbrands) | **GET** /api/brands | 

[*BrandsApi*](doc/BrandsApi.md) | [**brandsControllerUpdateBrand**](doc/BrandsApi.md#brandscontrollerupdatebrand) | **PATCH** /api/brands/{id} | 

[*ImagesApi*](doc/ImagesApi.md) | [**imagesControllerGetImageByPublicId**](doc/ImagesApi.md#imagescontrollergetimagebypublicid) | **GET** /api/images/{publicId} | Get image by public id

[*ImagesApi*](doc/ImagesApi.md) | [**imagesControllerUploadArrayImages**](doc/ImagesApi.md#imagescontrolleruploadarrayimages) | **POST** /api/images | Upload multiple image

[*SkusApi*](doc/SkusApi.md) | [**skusControllerAddSerialNumbers**](doc/SkusApi.md#skuscontrolleraddserialnumbers) | **POST** /api/skus/{id}/serial-numbers | 

[*SkusApi*](doc/SkusApi.md) | [**skusControllerCreateSku**](doc/SkusApi.md#skuscontrollercreatesku) | **POST** /api/skus | 

[*SkusApi*](doc/SkusApi.md) | [**skusControllerGetSkuById**](doc/SkusApi.md#skuscontrollergetskubyid) | **GET** /api/skus/{id} | 

[*SkusApi*](doc/SkusApi.md) | [**skusControllerGetSkus**](doc/SkusApi.md#skuscontrollergetskus) | **GET** /api/skus | 

[*SkusApi*](doc/SkusApi.md) | [**skusControllerUpdateSkuById**](doc/SkusApi.md#skuscontrollerupdateskubyid) | **PATCH** /api/skus/{id} | 

[*SpusApi*](doc/SpusApi.md) | [**sPUControllerAddSpuModels**](doc/SpusApi.md#spucontrolleraddspumodels) | **POST** /api/spus/{id}/models | 

[*SpusApi*](doc/SpusApi.md) | [**sPUControllerCreateSPU**](doc/SpusApi.md#spucontrollercreatespu) | **POST** /api/spus | 

[*SpusApi*](doc/SpusApi.md) | [**sPUControllerGetSPU**](doc/SpusApi.md#spucontrollergetspu) | **GET** /api/spus/{id} | 

[*SpusApi*](doc/SpusApi.md) | [**sPUControllerGetSPUs**](doc/SpusApi.md#spucontrollergetspus) | **GET** /api/spus | 

[*SpusApi*](doc/SpusApi.md) | [**sPUControllerUpdateSPU**](doc/SpusApi.md#spucontrollerupdatespu) | **PATCH** /api/spus/{id} | 

[*SpusApi*](doc/SpusApi.md) | [**sPUControllerUpdateSpuModel**](doc/SpusApi.md#spucontrollerupdatespumodel) | **PATCH** /api/spus/{id}/models/{slug} | 

[*TagsApi*](doc/TagsApi.md) | [**tagsControllerCreateTag**](doc/TagsApi.md#tagscontrollercreatetag) | **POST** /api/tags | 

[*TagsApi*](doc/TagsApi.md) | [**tagsControllerGetTag**](doc/TagsApi.md#tagscontrollergettag) | **GET** /api/tags/{id} | 

[*TagsApi*](doc/TagsApi.md) | [**tagsControllerGetTags**](doc/TagsApi.md#tagscontrollergettags) | **GET** /api/tags | 

[*TagsApi*](doc/TagsApi.md) | [**tagsControllerUpdateTag**](doc/TagsApi.md#tagscontrollerupdatetag) | **PATCH** /api/tags/{id} | 

[*UsersApi*](doc/UsersApi.md) | [**usersControllerCreate**](doc/UsersApi.md#userscontrollercreate) | **POST** /api/users | 

[*UsersApi*](doc/UsersApi.md) | [**usersControllerGetUserId**](doc/UsersApi.md#userscontrollergetuserid) | **GET** /api/users/{id} | 

[*UsersApi*](doc/UsersApi.md) | [**usersControllerGetUsers**](doc/UsersApi.md#userscontrollergetusers) | **GET** /api/users | 

[*UsersApi*](doc/UsersApi.md) | [**usersControllerUpdateUserMnt**](doc/UsersApi.md#userscontrollerupdateusermnt) | **PATCH** /api/users/{id} | 

## Documentation For Models

 - [AddSerialNumberDto](doc/AddSerialNumberDto.md)

 - [AddSerialNumberResponseDto](doc/AddSerialNumberResponseDto.md)

 - [AddSpuModelDto](doc/AddSpuModelDto.md)

 - [Attribute](doc/Attribute.md)

 - [AttributeInProductSchema](doc/AttributeInProductSchema.md)

 - [AttributeInProductSchemaDto](doc/AttributeInProductSchemaDto.md)

 - [AttributeInfinityPaginationResult](doc/AttributeInfinityPaginationResult.md)

 - [AuthConfirmEmailDto](doc/AuthConfirmEmailDto.md)

 - [AuthEmailLoginDto](doc/AuthEmailLoginDto.md)

 - [AuthFacebookLoginDto](doc/AuthFacebookLoginDto.md)

 - [AuthForgotPasswordDto](doc/AuthForgotPasswordDto.md)

 - [AuthGoogleLoginDto](doc/AuthGoogleLoginDto.md)

 - [AuthResetPasswordDto](doc/AuthResetPasswordDto.md)

 - [AuthSignupDto](doc/AuthSignupDto.md)

 - [AuthUpdateDto](doc/AuthUpdateDto.md)

 - [AvatarSchema](doc/AvatarSchema.md)

 - [BlockActivityLog](doc/BlockActivityLog.md)

 - [BlockActivityLogDto](doc/BlockActivityLogDto.md)

 - [BlockUserDto](doc/BlockUserDto.md)

 - [Brand](doc/Brand.md)

 - [BrandInfinityPaginationResult](doc/BrandInfinityPaginationResult.md)

 - [CreateAttributeDto](doc/CreateAttributeDto.md)

 - [CreateBrandDto](doc/CreateBrandDto.md)

 - [CreateSkuDto](doc/CreateSkuDto.md)

 - [CreateSpuDto](doc/CreateSpuDto.md)

 - [CreateTagDto](doc/CreateTagDto.md)

 - [CreateUserDto](doc/CreateUserDto.md)

 - [DistrictLevel](doc/DistrictLevel.md)

 - [DistrictSchemaDTO](doc/DistrictSchemaDTO.md)

 - [Errors](doc/Errors.md)

 - [FilterAttributeDto](doc/FilterAttributeDto.md)

 - [FilterBrandsDto](doc/FilterBrandsDto.md)

 - [FilterSkuDto](doc/FilterSkuDto.md)

 - [FilterSpuDto](doc/FilterSpuDto.md)

 - [FilterTagDto](doc/FilterTagDto.md)

 - [FilterUserDto](doc/FilterUserDto.md)

 - [GhnDistrictDTO](doc/GhnDistrictDTO.md)

 - [GhnProvinceDTO](doc/GhnProvinceDTO.md)

 - [GhnWardDTO](doc/GhnWardDTO.md)

 - [ImageSchema](doc/ImageSchema.md)

 - [ImageSchemaDto](doc/ImageSchemaDto.md)

 - [ImageUploadedResponseDTO](doc/ImageUploadedResponseDTO.md)

 - [LoginResponseDto](doc/LoginResponseDto.md)

 - [PriceSchema](doc/PriceSchema.md)

 - [ProvinceLevel](doc/ProvinceLevel.md)

 - [ProvinceSchemaDTO](doc/ProvinceSchemaDTO.md)

 - [RefreshTokenDto](doc/RefreshTokenDto.md)

 - [RefreshTokenResponseDto](doc/RefreshTokenResponseDto.md)

 - [ResendConfirmEmail](doc/ResendConfirmEmail.md)

 - [SKU](doc/SKU.md)

 - [SPU](doc/SPU.md)

 - [SPUModelSchema](doc/SPUModelSchema.md)

 - [SPUModelSchemaDto](doc/SPUModelSchemaDto.md)

 - [SkuImageSchema](doc/SkuImageSchema.md)

 - [SkuInfinityPaginationResult](doc/SkuInfinityPaginationResult.md)

 - [SortAttributeDto](doc/SortAttributeDto.md)

 - [SortSkuDto](doc/SortSkuDto.md)

 - [SortSpuDto](doc/SortSpuDto.md)

 - [SortTagDto](doc/SortTagDto.md)

 - [SortUserDto](doc/SortUserDto.md)

 - [SpuInfinityPaginationResult](doc/SpuInfinityPaginationResult.md)

 - [Tag](doc/Tag.md)

 - [TagInfinityPaginationResult](doc/TagInfinityPaginationResult.md)

 - [UpdateAttributeDto](doc/UpdateAttributeDto.md)

 - [UpdateBrandDto](doc/UpdateBrandDto.md)

 - [UpdateSPUModelSchemaDto](doc/UpdateSPUModelSchemaDto.md)

 - [UpdateSpuDto](doc/UpdateSpuDto.md)

 - [UpdateTagDto](doc/UpdateTagDto.md)

 - [UpdateUserMntDto](doc/UpdateUserMntDto.md)

 - [User](doc/User.md)

 - [UserAddressSchema](doc/UserAddressSchema.md)

 - [UserAddressSchemaDTO](doc/UserAddressSchemaDTO.md)

 - [UserBlockSchema](doc/UserBlockSchema.md)

 - [UserInfinityPaginationResult](doc/UserInfinityPaginationResult.md)

 - [WardLevel](doc/WardLevel.md)

 - [WardSchemaDTO](doc/WardSchemaDTO.md)

## Documentation For Authorization

Authentication schemes defined for the API:

### bearer

- **Type**: HTTP Bearer Token authentication (JWT)

## Author

teams@techcell.cloud
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/techcell-project/dart-dio-sdk

Awesome Lists containing this project

README
