# openapi.api.BrandsApi

## Load the API package
```dart
import 'package:openapi/api.dart';
```

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createBrand**](BrandsApi.md#createbrand) | **POST** /api/product/brands | Create a brand
[**getAllBrand**](BrandsApi.md#getallbrand) | **GET** /api/product/brands | Get all brands
[**updateDefaultBrand**](BrandsApi.md#updatedefaultbrand) | **PUT** /api/product/brands/default | Update default brand's information


# **createBrand**
> BrandEntity createBrand(createBrandBody)

Create a brand

Creates a new brand

### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getBrandsApi();
final CreateBrandBody createBrandBody = ; // CreateBrandBody | 

try {
    final response = api.createBrand(createBrandBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling BrandsApi->createBrand: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createBrandBody** | [**CreateBrandBody**](CreateBrandBody.md)|  | 

### Return type

[**BrandEntity**](BrandEntity.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[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)

# **getAllBrand**
> GetAllBrandsResponse getAllBrand(name)

Get all brands

Get a list of brands with pagination

### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getBrandsApi();
final String name = brand; // String | Brand's name to search, leave it empty to get all brands

try {
    final response = api.getAllBrand(name);
    print(response);
} catch on DioError (e) {
    print('Exception when calling BrandsApi->getAllBrand: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **name** | **String**| Brand's name to search, leave it empty to get all brands | [optional] 

### Return type

[**GetAllBrandsResponse**](GetAllBrandsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[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)

# **updateDefaultBrand**
> OkRes updateDefaultBrand(updateDefaultBrandBody)

Update default brand's information

Updates default brand's information (name and image)

### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getBrandsApi();
final UpdateDefaultBrandBody updateDefaultBrandBody = ; // UpdateDefaultBrandBody | 

try {
    final response = api.updateDefaultBrand(updateDefaultBrandBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling BrandsApi->updateDefaultBrand: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **updateDefaultBrandBody** | [**UpdateDefaultBrandBody**](UpdateDefaultBrandBody.md)|  | 

### Return type

[**OkRes**](OkRes.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[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)