# openapi.api.ShopTemplateApi

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

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**activateShop**](ShopTemplateApi.md#activateshop) | **POST** /api/template/shop/activate/{id} | Activate shop template
[**changeShopTemplatePageStatus**](ShopTemplateApi.md#changeshoptemplatepagestatus) | **POST** /api/template/shop/page/status/{id} | Change shop template page status
[**createAppBar**](ShopTemplateApi.md#createappbar) | **POST** /api/template/shop/{id}/app-bar | Create app bar
[**createEmptyTemplate**](ShopTemplateApi.md#createemptytemplate) | **POST** /api/template/shop/empty | Create template
[**createMenu**](ShopTemplateApi.md#createmenu) | **POST** /api/template/shop/menu | Create menu
[**createShopTemplatePage**](ShopTemplateApi.md#createshoptemplatepage) | **POST** /api/template/shop/page/{id} | Create shop template page
[**createTemplate**](ShopTemplateApi.md#createtemplate) | **POST** /api/template/shop | Create template
[**deleteMenu**](ShopTemplateApi.md#deletemenu) | **DELETE** /api/template/shop/menu/{id} | Delete menu
[**deleteShopTemplatePage**](ShopTemplateApi.md#deleteshoptemplatepage) | **DELETE** /api/template/shop/page/{id} | Delete shop template page
[**deleteTemplate**](ShopTemplateApi.md#deletetemplate) | **DELETE** /api/template/shop/{id} | Delete template by id
[**getActiveTemplate**](ShopTemplateApi.md#getactivetemplate) | **GET** /api/template/shop/active-template | Get active template
[**getAppBar**](ShopTemplateApi.md#getappbar) | **GET** /api/template/shop/{id}/app-bar | Get app bar
[**getMenu**](ShopTemplateApi.md#getmenu) | **GET** /api/template/shop/menu/{id} | Get menu
[**getMenus**](ShopTemplateApi.md#getmenus) | **GET** /api/template/shop/menu | Get menus
[**getPageSeoFromPath**](ShopTemplateApi.md#getpageseofrompath) | **GET** /api/template/shop/page/seo/{path} | Get page seo from path
[**getTemplate**](ShopTemplateApi.md#gettemplate) | **GET** /api/template/shop/{id} | Get template by id
[**getTemplates**](ShopTemplateApi.md#gettemplates) | **GET** /api/template/shop | Get templates
[**importShopTemplate**](ShopTemplateApi.md#importshoptemplate) | **POST** /api/template/shop/import/{id} | Import shop template
[**makeTemplateDefault**](ShopTemplateApi.md#maketemplatedefault) | **PUT** /api/template/shop/{id}/default | Make template default
[**templateCheckoutSession**](ShopTemplateApi.md#templatecheckoutsession) | **GET** /api/template/shop/checkout-session/{id} | Create checkout session
[**updateMenu**](ShopTemplateApi.md#updatemenu) | **PUT** /api/template/shop/menu/{id} | Update menu
[**updateShopTemplatePage**](ShopTemplateApi.md#updateshoptemplatepage) | **PUT** /api/template/shop/{templateId}/page/{pageId} | Update shop template page


# **activateShop**
> OkRes activateShop(id)

Activate shop template

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**OkRes**](OkRes.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)

# **changeShopTemplatePageStatus**
> TemplateEntity changeShopTemplatePageStatus(id, changeShopTemplateDataStatusBody)

Change shop template page status

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 
final ChangeShopTemplateDataStatusBody changeShopTemplateDataStatusBody = ; // ChangeShopTemplateDataStatusBody | 

try {
    final response = api.changeShopTemplatePageStatus(id, changeShopTemplateDataStatusBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ShopTemplateApi->changeShopTemplatePageStatus: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **changeShopTemplateDataStatusBody** | [**ChangeShopTemplateDataStatusBody**](ChangeShopTemplateDataStatusBody.md)|  | 

### Return type

[**TemplateEntity**](TemplateEntity.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)

# **createAppBar**
> TemplateAppBarEntity createAppBar(id, createAppBar)

Create app bar

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 
final CreateAppBar createAppBar = ; // CreateAppBar | 

try {
    final response = api.createAppBar(id, createAppBar);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ShopTemplateApi->createAppBar: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **createAppBar** | [**CreateAppBar**](CreateAppBar.md)|  | 

### Return type

[**TemplateAppBarEntity**](TemplateAppBarEntity.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)

# **createEmptyTemplate**
> OkRes createEmptyTemplate(createEmptyTemplateBody)

Create template

Only available for owner

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

final api = Openapi().getShopTemplateApi();
final CreateEmptyTemplateBody createEmptyTemplateBody = ; // CreateEmptyTemplateBody | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createEmptyTemplateBody** | [**CreateEmptyTemplateBody**](CreateEmptyTemplateBody.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)

# **createMenu**
> OkRes createMenu(createMenuDto)

Create menu

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

final api = Openapi().getShopTemplateApi();
final CreateMenuDto createMenuDto = ; // CreateMenuDto | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createMenuDto** | [**CreateMenuDto**](CreateMenuDto.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)

# **createShopTemplatePage**
> TemplateEntity createShopTemplatePage(id, createShopTemplatePageBody)

Create shop template page

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 
final CreateShopTemplatePageBody createShopTemplatePageBody = ; // CreateShopTemplatePageBody | 

try {
    final response = api.createShopTemplatePage(id, createShopTemplatePageBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ShopTemplateApi->createShopTemplatePage: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **createShopTemplatePageBody** | [**CreateShopTemplatePageBody**](CreateShopTemplatePageBody.md)|  | 

### Return type

[**TemplateEntity**](TemplateEntity.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)

# **createTemplate**
> TemplateAppBarEntity createTemplate(createTemplateBody)

Create template

Only available for owner

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

final api = Openapi().getShopTemplateApi();
final CreateTemplateBody createTemplateBody = ; // CreateTemplateBody | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createTemplateBody** | [**CreateTemplateBody**](CreateTemplateBody.md)|  | 

### Return type

[**TemplateAppBarEntity**](TemplateAppBarEntity.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)

# **deleteMenu**
> OkRes deleteMenu(id)

Delete menu

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**OkRes**](OkRes.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)

# **deleteShopTemplatePage**
> OkRes deleteShopTemplatePage(id)

Delete shop template page

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**OkRes**](OkRes.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)

# **deleteTemplate**
> OkRes deleteTemplate(id)

Delete template by id

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**OkRes**](OkRes.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)

# **getActiveTemplate**
> GetActiveTemplateDataRes getActiveTemplate()

Get active template

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

final api = Openapi().getShopTemplateApi();

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**GetActiveTemplateDataRes**](GetActiveTemplateDataRes.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)

# **getAppBar**
> TemplateAppBarEntity getAppBar(id)

Get app bar

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**TemplateAppBarEntity**](TemplateAppBarEntity.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)

# **getMenu**
> TemplateMenuEntity getMenu(id)

Get menu

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**TemplateMenuEntity**](TemplateMenuEntity.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)

# **getMenus**
> BuiltList<TemplateMenuEntity> getMenus(search, sort)

Get menus

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

final api = Openapi().getShopTemplateApi();
final String search = search_example; // String | 
final String sort = sort_example; // String | 

try {
    final response = api.getMenus(search, sort);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ShopTemplateApi->getMenus: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **search** | **String**|  | 
 **sort** | **String**|  | 

### Return type

[**BuiltList&lt;TemplateMenuEntity&gt;**](TemplateMenuEntity.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)

# **getPageSeoFromPath**
> GetPageSeoFromIdRes getPageSeoFromPath(path)

Get page seo from path

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

final api = Openapi().getShopTemplateApi();
final String path = path_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **path** | **String**|  | 

### Return type

[**GetPageSeoFromIdRes**](GetPageSeoFromIdRes.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)

# **getTemplate**
> TemplateEntity getTemplate(id, path)

Get template by id

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 
final String path = path_example; // String | 

try {
    final response = api.getTemplate(id, path);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ShopTemplateApi->getTemplate: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **path** | **String**|  | [optional] 

### Return type

[**TemplateEntity**](TemplateEntity.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)

# **getTemplates**
> BuiltList<FindAllTemplateRes> getTemplates()

Get templates

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

final api = Openapi().getShopTemplateApi();

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**BuiltList&lt;FindAllTemplateRes&gt;**](FindAllTemplateRes.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)

# **importShopTemplate**
> OkRes importShopTemplate(id)

Import shop template

Import template from public templates

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**OkRes**](OkRes.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)

# **makeTemplateDefault**
> OkRes makeTemplateDefault(id)

Make template default

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**OkRes**](OkRes.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)

# **templateCheckoutSession**
> String templateCheckoutSession(id)

Create checkout session

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

**String**

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

# **updateMenu**
> OkRes updateMenu(id, updateMenuDto)

Update menu

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

final api = Openapi().getShopTemplateApi();
final String id = id_example; // String | 
final UpdateMenuDto updateMenuDto = ; // UpdateMenuDto | 

try {
    final response = api.updateMenu(id, updateMenuDto);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ShopTemplateApi->updateMenu: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **updateMenuDto** | [**UpdateMenuDto**](UpdateMenuDto.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)

# **updateShopTemplatePage**
> TemplateEntity updateShopTemplatePage(pageId, templateId, updateShopTemplatePageBody)

Update shop template page

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

final api = Openapi().getShopTemplateApi();
final String pageId = pageId_example; // String | 
final String templateId = templateId_example; // String | 
final UpdateShopTemplatePageBody updateShopTemplatePageBody = ; // UpdateShopTemplatePageBody | 

try {
    final response = api.updateShopTemplatePage(pageId, templateId, updateShopTemplatePageBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling ShopTemplateApi->updateShopTemplatePage: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **pageId** | **String**|  | 
 **templateId** | **String**|  | 
 **updateShopTemplatePageBody** | [**UpdateShopTemplatePageBody**](UpdateShopTemplatePageBody.md)|  | 

### Return type

[**TemplateEntity**](TemplateEntity.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)