# openapi.api.DraftOrdersApi

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

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**callGet**](DraftOrdersApi.md#callget) | **GET** /api/order/draft-orders/{id} | Get a draft order by ID
[**completeOrder**](DraftOrdersApi.md#completeorder) | **POST** /api/order/draft-orders/{id}/complete | Complete draft order
[**create**](DraftOrdersApi.md#create) | **POST** /api/order/draft-orders | Create a new draft order
[**createComment**](DraftOrdersApi.md#createcomment) | **POST** /api/order/draft-orders/{draftOrderId}/comment | Comment on a draft
[**deleteComment**](DraftOrdersApi.md#deletecomment) | **DELETE** /api/order/draft-orders/{draftOrderId}/comment/{id} | Delete a comment from a draft order
[**deleteProduct**](DraftOrdersApi.md#deleteproduct) | **DELETE** /api/order/draft-orders/{id} | Cancel a draft order
[**duplicate**](DraftOrdersApi.md#duplicate) | **POST** /api/order/draft-orders/duplicate/{id} | Duplicate a draft order
[**getAll**](DraftOrdersApi.md#getall) | **GET** /api/order/draft-orders | Get All draft orders
[**update**](DraftOrdersApi.md#update) | **PATCH** /api/order/draft-orders/{id} | Update a draft order


# **callGet**
> GetDraftOrderResponseDto callGet(id)

Get a draft order by ID

Get All draft orders with pagination

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

final api = Openapi().getDraftOrdersApi();
final num id = 8.14; // num | ID of Draft Order

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **num**| ID of Draft Order | 

### Return type

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

# **completeOrder**
> GetOrderDraftOrderResponseDto completeOrder(id, completeOrderBody)

Complete draft order

Complete the draft and move it to orders

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

final api = Openapi().getDraftOrdersApi();
final num id = 8.14; // num | Draft Order Id
final CompleteOrderBody completeOrderBody = {"paymentProviderId":1}; // CompleteOrderBody | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **num**| Draft Order Id | 
 **completeOrderBody** | [**CompleteOrderBody**](CompleteOrderBody.md)|  | 

### Return type

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

# **create**
> DraftOrderEntity create(draftOrderEntity)

Create a new draft order

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

final api = Openapi().getDraftOrdersApi();
final DraftOrderEntity draftOrderEntity = ; // DraftOrderEntity | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **draftOrderEntity** | [**DraftOrderEntity**](DraftOrderEntity.md)|  | 

### Return type

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

# **createComment**
> DraftOrderCommentEntity createComment(draftOrderId, draftOrderCommentEntity)

Comment on a draft

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

final api = Openapi().getDraftOrdersApi();
final num draftOrderId = 8.14; // num | ID of DraftOrder
final DraftOrderCommentEntity draftOrderCommentEntity = ; // DraftOrderCommentEntity | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **draftOrderId** | **num**| ID of DraftOrder | 
 **draftOrderCommentEntity** | [**DraftOrderCommentEntity**](DraftOrderCommentEntity.md)|  | 

### Return type

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

# **deleteComment**
> OkRes deleteComment(draftOrderId, id)

Delete a comment from a draft order

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

final api = Openapi().getDraftOrdersApi();
final num draftOrderId = 1; // num | ID of Draft Order's Comment
final num id = 1; // num | ID of Comment to Delete

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **draftOrderId** | **num**| ID of Draft Order's Comment | 
 **id** | **num**| ID of Comment to Delete | 

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

# **deleteProduct**
> OkRes deleteProduct(id)

Cancel a draft order

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

final api = Openapi().getDraftOrdersApi();
final num id = 8.14; // num | 

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

### Parameters

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

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

# **duplicate**
> GetDraftOrderResponseDto duplicate(id)

Duplicate a draft order

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

final api = Openapi().getDraftOrdersApi();
final num id = 8.14; // num | Draft Order Id

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **num**| Draft Order Id | 

### Return type

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

# **getAll**
> GetAllDraftOrdersResponseDto getAll(page, limit, search, sort, status)

Get All draft orders

Get All draft orders with pagination

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

final api = Openapi().getDraftOrdersApi();
final num page = 8.14; // num | Page number
final num limit = 8.14; // num | Number of results to be returned
final String search = search_example; // String | 
final GetAllDraftOrdersSort sort = ; // GetAllDraftOrdersSort | sort of draftOrders
final GetAllDraftOrdersStatusEnum status = ; // GetAllDraftOrdersStatusEnum | status of draftOrder

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page** | **num**| Page number | [default to 1]
 **limit** | **num**| Number of results to be returned | [default to 10]
 **search** | **String**|  | [optional] 
 **sort** | [**GetAllDraftOrdersSort**](.md)| sort of draftOrders | [optional] 
 **status** | [**GetAllDraftOrdersStatusEnum**](.md)| status of draftOrder | [optional] 

### Return type

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

# **update**
> GetDraftOrderResponseDto update(id, updateDraftOrderBody)

Update a draft order

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

final api = Openapi().getDraftOrdersApi();
final num id = 8.14; // num | Draft Order Id
final UpdateDraftOrderBody updateDraftOrderBody = ; // UpdateDraftOrderBody | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **num**| Draft Order Id | 
 **updateDraftOrderBody** | [**UpdateDraftOrderBody**](UpdateDraftOrderBody.md)|  | 

### Return type

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