# Sylius\AvatarImageApi

Resource &#39;AvatarImage&#39; operations.

All URIs are relative to http://localhost, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**syliusApiAdminAdminUserAvatarImageDelete()**](AvatarImageApi.md#syliusApiAdminAdminUserAvatarImageDelete) | **DELETE** /api/v2/admin/administrators/{id}/avatar-image | Removes the AvatarImage resource. |
| [**syliusApiAdminAdminUserAvatarImageGet()**](AvatarImageApi.md#syliusApiAdminAdminUserAvatarImageGet) | **GET** /api/v2/admin/administrators/{id}/avatar-image | Retrieves a AvatarImage resource. |
| [**syliusApiAdminAdminUserAvatarImagePost()**](AvatarImageApi.md#syliusApiAdminAdminUserAvatarImagePost) | **POST** /api/v2/admin/administrators/{id}/avatar-image | Creates a AvatarImage resource. |


## `syliusApiAdminAdminUserAvatarImageDelete()`

```php
syliusApiAdminAdminUserAvatarImageDelete($id, $accept_language)
```

Removes the AvatarImage resource.

Removes the AvatarImage resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\AvatarImageApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | AvatarImage identifier
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $apiInstance->syliusApiAdminAdminUserAvatarImageDelete($id, $accept_language);
} catch (Exception $e) {
    echo 'Exception when calling AvatarImageApi->syliusApiAdminAdminUserAvatarImageDelete: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **string**| AvatarImage identifier | |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

void (empty response body)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/ld+json`, `application/problem+json`, `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `syliusApiAdminAdminUserAvatarImageGet()`

```php
syliusApiAdminAdminUserAvatarImageGet($id, $image_filter, $accept_language): \Sylius\Model\AvatarImageJsonldSyliusAdminAvatarImageShow
```

Retrieves a AvatarImage resource.

Retrieves a AvatarImage resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\AvatarImageApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | AvatarImage identifier
$image_filter = 'image_filter_example'; // string | Image filter to be applied on image resources.
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $result = $apiInstance->syliusApiAdminAdminUserAvatarImageGet($id, $image_filter, $accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvatarImageApi->syliusApiAdminAdminUserAvatarImageGet: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **string**| AvatarImage identifier | |
| **image_filter** | **string**| Image filter to be applied on image resources. | [optional] |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

[**\Sylius\Model\AvatarImageJsonldSyliusAdminAvatarImageShow**](../Model/AvatarImageJsonldSyliusAdminAvatarImageShow.md)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/ld+json`, `application/json`, `application/problem+json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `syliusApiAdminAdminUserAvatarImagePost()`

```php
syliusApiAdminAdminUserAvatarImagePost($id, $accept_language, $file): \Sylius\Model\AvatarImageJsonldSyliusAdminAvatarImageShow
```

Creates a AvatarImage resource.

Creates a AvatarImage resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\AvatarImageApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | AvatarImage identifier
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.
$file = '/path/to/file.txt'; // \SplFileObject

try {
    $result = $apiInstance->syliusApiAdminAdminUserAvatarImagePost($id, $accept_language, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvatarImageApi->syliusApiAdminAdminUserAvatarImagePost: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **string**| AvatarImage identifier | |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |
| **file** | **\SplFileObject****\SplFileObject**|  | [optional] |

### Return type

[**\Sylius\Model\AvatarImageJsonldSyliusAdminAvatarImageShow**](../Model/AvatarImageJsonldSyliusAdminAvatarImageShow.md)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: `multipart/form-data`
- **Accept**: `application/ld+json`, `application/json`, `application/problem+json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
