# openapi.api.SuperAdminNewsletterApi

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

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](SuperAdminNewsletterApi.md#create) | **POST** /api/admin/super-admin/newsletter | 
[**delete**](SuperAdminNewsletterApi.md#delete) | **DELETE** /api/admin/super-admin/newsletter/{id} | 
[**findAll**](SuperAdminNewsletterApi.md#findall) | **GET** /api/admin/super-admin/newsletter | 
[**findAllEmails**](SuperAdminNewsletterApi.md#findallemails) | **GET** /api/admin/super-admin/newsletter/emails | 
[**findDefault**](SuperAdminNewsletterApi.md#finddefault) | **GET** /api/admin/super-admin/newsletter/default | 
[**findOne**](SuperAdminNewsletterApi.md#findone) | **GET** /api/admin/super-admin/newsletter/{id} | 
[**makeDefault**](SuperAdminNewsletterApi.md#makedefault) | **PUT** /api/admin/super-admin/newsletter/{id}/default | 
[**subscribe**](SuperAdminNewsletterApi.md#subscribe) | **POST** /api/admin/super-admin/newsletter/subscribe | 


# **create**
> NewsletterEntity create(newsletterEntity)



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

final api = Openapi().getSuperAdminNewsletterApi();
final NewsletterEntity newsletterEntity = ; // NewsletterEntity | 

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **newsletterEntity** | [**NewsletterEntity**](NewsletterEntity.md)|  | 

### Return type

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

# **delete**
> OkRes delete(id)



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

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

try {
    final response = api.delete(id);
    print(response);
} catch on DioError (e) {
    print('Exception when calling SuperAdminNewsletterApi->delete: $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)

# **findAll**
> FindAllNewsletterRes findAll()



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

final api = Openapi().getSuperAdminNewsletterApi();

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

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

### Return type

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

# **findAllEmails**
> FindAllNewsletterEmailRes findAllEmails(page, limit, search, sort)



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

final api = Openapi().getSuperAdminNewsletterApi();
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 GetAllNewsletterEmailSort sort = ; // GetAllNewsletterEmailSort | sort of customer

try {
    final response = api.findAllEmails(page, limit, search, sort);
    print(response);
} catch on DioError (e) {
    print('Exception when calling SuperAdminNewsletterApi->findAllEmails: $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** | [**GetAllNewsletterEmailSort**](.md)| sort of customer | [optional] 

### Return type

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

# **findDefault**
> NewsletterEntity findDefault()



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

final api = Openapi().getSuperAdminNewsletterApi();

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

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

### Return type

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

# **findOne**
> NewsletterEntity findOne(id)



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

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

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

### Parameters

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

### Return type

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

# **makeDefault**
> OkRes makeDefault(id)



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

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

try {
    final response = api.makeDefault(id);
    print(response);
} catch on DioError (e) {
    print('Exception when calling SuperAdminNewsletterApi->makeDefault: $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)

# **subscribe**
> OkRes subscribe(newsletterSubscribeDto)



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

final api = Openapi().getSuperAdminNewsletterApi();
final NewsletterSubscribeDto newsletterSubscribeDto = ; // NewsletterSubscribeDto | 

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

### Parameters

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