MagDv\Cargomart\FileApi

All URIs are relative to https://cargomart.ru.

Method	HTTP request	Description
apiV2FileClearDelete()	DELETE /api/v2/file/clear	Удаление всех временных файлов пользователя, не привязанных к документам.
apiV2FileDelete()	DELETE /api/v2/file	Удаление списка файлов.
apiV2FileGet()	GET /api/v2/file	Получение списка не привязанных к документам временных файлов
apiV2FileIdDelete()	DELETE /api/v2/file/{id}	Удаление файла по его идентификатору.
apiV2FilePost()	POST /api/v2/file	Загрузка не привязанного к документам файла
apiV2UploadPost()	POST /api/v2/upload	Загрузка временного файла, не привязанного ни к чему

`apiV2FileClearDelete()`

apiV2FileClearDelete()

Удаление всех временных файлов пользователя, не привязанных к документам.

Производится физическое удаление всех временных файлов пользователя, не привязанных к документам.

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\FileApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);

try {
    $apiInstance->apiV2FileClearDelete();
} catch (Exception $e) {
    echo 'Exception when calling FileApi->apiV2FileClearDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`apiV2FileDelete()`

apiV2FileDelete($file_ids)

Удаление списка файлов.

Производится физическое удаление указанного списка файлов.

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\FileApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$file_ids = new \MagDv\Cargomart\Dto\FileIds(); // \MagDv\Cargomart\Dto\FileIds

try {
    $apiInstance->apiV2FileDelete($file_ids);
} catch (Exception $e) {
    echo 'Exception when calling FileApi->apiV2FileDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
file_ids	\MagDv\Cargomart\Dto\FileIds		[optional]

Return type

void (empty response body)

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`apiV2FileGet()`

apiV2FileGet($filter_file_type): \MagDv\Cargomart\Dto\FileList

Получение списка не привязанных к документам временных файлов

По идентификатору пользователя ищутся все временные файлы.

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\FileApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$filter_file_type = new \MagDv\Cargomart\Dto\\MagDv\Cargomart\Dto\FileType(); // \MagDv\Cargomart\Dto\FileType | Тип файла

try {
    $result = $apiInstance->apiV2FileGet($filter_file_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileApi->apiV2FileGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
filter_file_type	\MagDv\Cargomart\Dto\FileType	Тип файла	[optional]

Return type

\MagDv\Cargomart\Dto\FileList

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`apiV2FileIdDelete()`

apiV2FileIdDelete($id)

Удаление файла по его идентификатору.

Производится физическое удаление файла.

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\FileApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | Идентификатор файла.

try {
    $apiInstance->apiV2FileIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling FileApi->apiV2FileIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Идентификатор файла.

Return type

void (empty response body)

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`apiV2FilePost()`

apiV2FilePost($file_type, $file): \MagDv\Cargomart\Dto\FileItem

Загрузка не привязанного к документам файла

Файл помечается как временный и привязывается к тому, кто его загрузил. При успешной загрузке возвращает доступное имя для документа.

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\FileApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$file_type = new \MagDv\Cargomart\Dto\\MagDv\Cargomart\Dto\FileType(); // \MagDv\Cargomart\Dto\FileType | Тип загружаемого временного файла
$file = '/path/to/file.txt'; // \SplFileObject

try {
    $result = $apiInstance->apiV2FilePost($file_type, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileApi->apiV2FilePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
file_type	\MagDv\Cargomart\Dto\FileType	Тип загружаемого временного файла
file	\SplFileObject\SplFileObject

Return type

\MagDv\Cargomart\Dto\FileItem

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`apiV2UploadPost()`

apiV2UploadPost($type, $file): \MagDv\Cargomart\Dto\FileV2Item

Загрузка временного файла, не привязанного ни к чему

Файл помечается как временный и привязывается к тому, кто его загрузил. При успешной загрузке возвращает доступное имя для документа.

Example

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


// Configure API key authorization: CookieTokenAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

// Configure API key authorization: HeaderAuthorizationAuth
$config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MagDv\Cargomart\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MagDv\Cargomart\Api\FileApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$type = new \MagDv\Cargomart\Dto\\MagDv\Cargomart\Dto\TemporaryFileType(); // \MagDv\Cargomart\Dto\TemporaryFileType | Тип загружаемого временного файла
$file = '/path/to/file.txt'; // \SplFileObject

try {
    $result = $apiInstance->apiV2UploadPost($type, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileApi->apiV2UploadPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
type	\MagDv\Cargomart\Dto\TemporaryFileType	Тип загружаемого временного файла
file	\SplFileObject\SplFileObject

Return type

\MagDv\Cargomart\Dto\FileV2Item

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

FileApi.md

Latest commit

History

FileApi.md

File metadata and controls

MagDv\Cargomart\FileApi

apiV2FileClearDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2FileDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2FileGet()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2FileIdDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2FilePost()

Example

Parameters

Return type

Authorization

HTTP request headers

apiV2UploadPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`apiV2FileClearDelete()`

`apiV2FileDelete()`

`apiV2FileGet()`

`apiV2FileIdDelete()`

`apiV2FilePost()`

`apiV2UploadPost()`