# openapi.api.PartnerApi ## Load the API package ```dart import 'package:openapi/api.dart'; ``` All URIs are relative to */api* Method | HTTP request | Description ------------- | ------------- | ------------- [**createPartner**](PartnerApi.md#createpartner) | **POST** /partner/{id} | [**getPartners**](PartnerApi.md#getpartners) | **GET** /partner | [**removePartner**](PartnerApi.md#removepartner) | **DELETE** /partner/{id} | [**updatePartner**](PartnerApi.md#updatepartner) | **PUT** /partner/{id} | # **createPartner** > PartnerResponseDto createPartner(id) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = PartnerApi(); final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | try { final result = api_instance.createPartner(id); print(result); } catch (e) { print('Exception when calling PartnerApi->createPartner: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type [**PartnerResponseDto**](PartnerResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### 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) # **getPartners** > List getPartners(direction) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = PartnerApi(); final direction = direction_example; // String | try { final result = api_instance.getPartners(direction); print(result); } catch (e) { print('Exception when calling PartnerApi->getPartners: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **direction** | **String**| | ### Return type [**List**](PartnerResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### 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) # **removePartner** > removePartner(id) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = PartnerApi(); final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | try { api_instance.removePartner(id); } catch (e) { print('Exception when calling PartnerApi->removePartner: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type void (empty response body) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[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) # **updatePartner** > PartnerResponseDto updatePartner(id, updatePartnerDto) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = PartnerApi(); final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | final updatePartnerDto = UpdatePartnerDto(); // UpdatePartnerDto | try { final result = api_instance.updatePartner(id, updatePartnerDto); print(result); } catch (e) { print('Exception when calling PartnerApi->updatePartner: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **updatePartnerDto** | [**UpdatePartnerDto**](UpdatePartnerDto.md)| | ### Return type [**PartnerResponseDto**](PartnerResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### 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)