Skip to content

Latest commit

 

History

History
222 lines (159 loc) · 7.43 KB

UploadsApi.md

File metadata and controls

222 lines (159 loc) · 7.43 KB

ListcleanSwagger\Client\UploadsApi

All URIs are relative to https://api.listclean.xyz/v1/

Method HTTP request Description
uploadsGet GET /uploads/ Get the list of uploads (csv upload)
uploadsPost POST /uploads/ Start the Upload (csv upload)
uploadsUploadIdGet GET /uploads/{upload_id} Get status of a Upload
uploadsUploadIdPost POST /uploads/{upload_id} Upload a Chunk [CHUNKS] (csv upload)

uploadsGet

\ListcleanSwagger\Client\Model\InlineResponse200 uploadsGet()

Get the list of uploads (csv upload)

Example

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

// Configure API key authorization: api_key
$config = ListcleanSwagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ListcleanSwagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$apiInstance = new ListcleanSwagger\Client\Api\UploadsApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\ListcleanSwagger\Client\Model\InlineResponse200

Authorization

api_key

HTTP request headers

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

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

uploadsPost

\ListcleanSwagger\Client\Model\InlineResponse2001 uploadsPost($body)

Start the Upload (csv upload)

Example

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

// Configure API key authorization: api_key
$config = ListcleanSwagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ListcleanSwagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$apiInstance = new ListcleanSwagger\Client\Api\UploadsApi(
    // 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
);
$body = new \ListcleanSwagger\Client\Model\Body(); // \ListcleanSwagger\Client\Model\Body | The body of the API call

try {
    $result = $apiInstance->uploadsPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadsApi->uploadsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \ListcleanSwagger\Client\Model\Body The body of the API call [optional]

Return type

\ListcleanSwagger\Client\Model\InlineResponse2001

Authorization

api_key

HTTP request headers

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

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

uploadsUploadIdGet

\ListcleanSwagger\Client\Model\InlineResponse2002 uploadsUploadIdGet($upload_id)

Get status of a Upload

Example

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

// Configure API key authorization: api_key
$config = ListcleanSwagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ListcleanSwagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$apiInstance = new ListcleanSwagger\Client\Api\UploadsApi(
    // 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
);
$upload_id = 56; // int | 

try {
    $result = $apiInstance->uploadsUploadIdGet($upload_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadsApi->uploadsUploadIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
upload_id int

Return type

\ListcleanSwagger\Client\Model\InlineResponse2002

Authorization

api_key

HTTP request headers

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

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

uploadsUploadIdPost

\ListcleanSwagger\Client\Model\InlineResponse2003 uploadsUploadIdPost($upload_id, $body)

Upload a Chunk [CHUNKS] (csv upload)

Example

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

// Configure API key authorization: api_key
$config = ListcleanSwagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ListcleanSwagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');

$apiInstance = new ListcleanSwagger\Client\Api\UploadsApi(
    // 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
);
$upload_id = 56; // int | 
$body = new \ListcleanSwagger\Client\Model\Body1(); // \ListcleanSwagger\Client\Model\Body1 | The body of the API call

try {
    $result = $apiInstance->uploadsUploadIdPost($upload_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadsApi->uploadsUploadIdPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
upload_id int
body \ListcleanSwagger\Client\Model\Body1 The body of the API call [optional]

Return type

\ListcleanSwagger\Client\Model\InlineResponse2003

Authorization

api_key

HTTP request headers

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

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