ListcleanSwaggerClient-php

Listclean APIs. For API reference doc at https://api.listclean.xyz.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 0.1.0
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/listclean/listclean-swagger-php.git"
    }
  ],
  "require": {
    "listclean/listclean-swagger-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/ListcleanSwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?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\AccountsApi(
    // 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->accountProfileGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountProfileGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountsApi	accountProfileGet	GET /account/profile/	Get account profile details
AccountsApi	accountProfilePost	POST /account/profile/	Update account profile details
ListsApi	listsGet	GET /lists/	Get the all list info
ListsApi	listsListIdDelete	DELETE /lists/{list_id}	Delete the single list
ListsApi	listsListIdGet	GET /lists/{list_id}	Get the single list info
UploadsApi	uploadsGet	GET /uploads/	Get the list of uploads (csv upload)
UploadsApi	uploadsPost	POST /uploads/	Start the Upload (csv upload)
UploadsApi	uploadsUploadIdGet	GET /uploads/{upload_id}	Get status of a Upload
UploadsApi	uploadsUploadIdPost	POST /uploads/{upload_id}	Upload a Chunk [CHUNKS] (csv upload)

Documentation For Models

• ApiResponse
• Body
• Body1
• Body2
• InlineResponse200
• InlineResponse2001
• InlineResponse2001Data
• InlineResponse2002
• InlineResponse2002Data
• InlineResponse2002DataChunkDetails
• InlineResponse2003
• InlineResponse2004
• InlineResponse2004Data
• InlineResponse2004DataAnalytics
• InlineResponse2004DataAnalyticsCleanSummary
• InlineResponse2004DataAnalyticsDirtySummary
• InlineResponse2004DataAnalyticsSummary
• InlineResponse2004DataAnalyticsSummaryClean
• InlineResponse2004DataAnalyticsSummaryDirty
• InlineResponse2004DataCost
• InlineResponse2004DataCostCost
• InlineResponse2004DataCostRate
• InlineResponse2004DataLists
• InlineResponse2005
• InlineResponse2006
• InlineResponse2007
• InlineResponse2007Data
• InlineResponse200Data

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: X-Auth-Token
• Location: HTTP header

Author

[email protected]