# SwaggerClient-php
<a href=\"https://www.cian.ru/help/about/37970/\">Условия использования</a>  ## Описание  ### Авторизация Для работы с API необходимо получить ключ авторизации. Для получения ключа нужно написать письмо на import@cian.ru с темой \"ACCESS KEY\" и названием агентства, которое вы представляете. Менеджер уточнит подробности и пришлет ACCESS KEY. Для каждой учетной записи на ЦИАН выдается отдельный ключ авторизации.  Далее все запросы выполняются с заголовком: `Authorization: Bearer <ACCESS KEY>`.  ### Дата и время Формат данных для времени (date-time): `2020-07-18 04:52:33.051204` и для даты (date): `2020-07-18`   Во всех запросах дата и время передаются и возвращаются в таймзоне `Europe/Moscow`.

This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0
- Build package: io.swagger.codegen.languages.PhpClientCodegen

## Requirements

PHP 5.5 and later

## Installation & Usage
### Composer

To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:

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

Then run `composer install`

### Manual Installation

Download the files and include `autoload.php`:

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

## Tests

To run the unit tests:

```
composer install
./vendor/bin/phpunit
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

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

$apiInstance = new Swagger\Client\Api\AgentsApi(
    // 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()
);
$page_size = 56; // int | Размер страницы.
$page = 56; // int | Номер запрашиваемой страницы.
$query = "query_example"; // string | Поисковый запрос
$statuses = array("statuses_example"); // string[] | Статусы
$user_ids = array(56); // int[] | Список сотрудников, которых нужно вернуть в ответе. Если не задан - вернуть информацию по всем сотрудникам.

try {
    $result = $apiInstance->v1GetAgentsGet($page_size, $page, $query, $statuses, $user_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentsApi->v1GetAgentsGet: ', $e->getMessage(), PHP_EOL;
}

?>
```

## Documentation for API Endpoints

All URIs are relative to *https://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AgentsApi* | [**v1GetAgentsGet**](docs/Api/AgentsApi.md#v1getagentsget) | **GET** /v1/get-agents | Получить список сотрудников
*AuctionApi* | [**v1GetAuctionGet**](docs/Api/AuctionApi.md#v1getauctionget) | **GET** /v1/get-auction | Получить информацию по ставкам на объявления
*BillingApi* | [**v1GetMyBalanceGet**](docs/Api/BillingApi.md#v1getmybalanceget) | **GET** /v1/get-my-balance | Получить текущий баланс
*BillingApi* | [**v1GetOfferActiveServicesGet**](docs/Api/BillingApi.md#v1getofferactiveservicesget) | **GET** /v1/get-offer-active-services | Получить активные услуги по объявлениям
*BillingApi* | [**v1GetOperationsGet**](docs/Api/BillingApi.md#v1getoperationsget) | **GET** /v1/get-operations | Получить список операций
*CallsApi* | [**v1GetCallRecordGet**](docs/Api/CallsApi.md#v1getcallrecordget) | **GET** /v1/get-call-record | Получить запись звонка
*CallsApi* | [**v1GetCallsReportGet**](docs/Api/CallsApi.md#v1getcallsreportget) | **GET** /v1/get-calls-report | Получить отчет по звонкам
*EstimationApi* | [**v1GetEstimationAndBtiGet**](docs/Api/EstimationApi.md#v1getestimationandbtiget) | **GET** /v1/get-estimation-and-bti | Получить оценку по адресу
*ImportOrdersApi* | [**v1GetImagesReportGet**](docs/Api/ImportOrdersApi.md#v1getimagesreportget) | **GET** /v1/get-images-report | Получить отчет об изображениях
*ImportOrdersApi* | [**v1GetLastOrderInfoGet**](docs/Api/ImportOrdersApi.md#v1getlastorderinfoget) | **GET** /v1/get-last-order-info | Получить состояние импорта объявлений
*ImportOrdersApi* | [**v1GetOrderGet**](docs/Api/ImportOrdersApi.md#v1getorderget) | **GET** /v1/get-order | Получить отчет по импорту объявлений
*ModerationApi* | [**v1GetComplaintsGet**](docs/Api/ModerationApi.md#v1getcomplaintsget) | **GET** /v1/get-complaints | Получить жалобы
*NotificationsApi* | [**v1GetNotificationsGet**](docs/Api/NotificationsApi.md#v1getnotificationsget) | **GET** /v1/get-notifications | Получить уведомления
*OffersApi* | [**v1GetMyOffersGet**](docs/Api/OffersApi.md#v1getmyoffersget) | **GET** /v1/get-my-offers | Получить объявления
*StatisticsApi* | [**v1GetSearchCoverageGet**](docs/Api/StatisticsApi.md#v1getsearchcoverageget) | **GET** /v1/get-search-coverage | Получить охват по объявлению
*StatisticsApi* | [**v1GetViewsStatisticsByDaysGet**](docs/Api/StatisticsApi.md#v1getviewsstatisticsbydaysget) | **GET** /v1/get-views-statistics-by-days | Получить статистику просмотров и показов телефонов по дням
*StatisticsApi* | [**v1GetViewsStatisticsGet**](docs/Api/StatisticsApi.md#v1getviewsstatisticsget) | **GET** /v1/get-views-statistics | Получить статистику просмотров и показов телефонов за все время


## Documentation For Models

 - [AgentBalanceResponseSchema](docs/Model/AgentBalanceResponseSchema.md)
 - [AgentPhoneResponseSchema](docs/Model/AgentPhoneResponseSchema.md)
 - [AgentResponseSchema](docs/Model/AgentResponseSchema.md)
 - [AgentServicePackagesLimitsSchema](docs/Model/AgentServicePackagesLimitsSchema.md)
 - [AgentSpendLimitResponseSchema](docs/Model/AgentSpendLimitResponseSchema.md)
 - [AgentsListResponseSchema](docs/Model/AgentsListResponseSchema.md)
 - [AgentsListResponseSchemaWrapper](docs/Model/AgentsListResponseSchemaWrapper.md)
 - [AnnouncementInfoModelSchema](docs/Model/AnnouncementInfoModelSchema.md)
 - [AnnouncementInfoResponseSchema](docs/Model/AnnouncementInfoResponseSchema.md)
 - [AnnouncementInfoResponseSchemaWrapper](docs/Model/AnnouncementInfoResponseSchemaWrapper.md)
 - [AnnouncementReportItemResponseSchema](docs/Model/AnnouncementReportItemResponseSchema.md)
 - [BalanceModelSchema](docs/Model/BalanceModelSchema.md)
 - [BalanceModelSchemaWrapper](docs/Model/BalanceModelSchemaWrapper.md)
 - [BonusBalanceSchema](docs/Model/BonusBalanceSchema.md)
 - [BtiDataSchema](docs/Model/BtiDataSchema.md)
 - [CallAgencyPresenterSchema](docs/Model/CallAgencyPresenterSchema.md)
 - [EmptyResponseSchema](docs/Model/EmptyResponseSchema.md)
 - [ErrorResponseSchema](docs/Model/ErrorResponseSchema.md)
 - [ErrorResponseSchemaWrapper](docs/Model/ErrorResponseSchemaWrapper.md)
 - [ErrorSchema](docs/Model/ErrorSchema.md)
 - [EstimationByRoomSchema](docs/Model/EstimationByRoomSchema.md)
 - [GetActualAppliedServicesApiResponseSchema](docs/Model/GetActualAppliedServicesApiResponseSchema.md)
 - [GetActualAppliedServicesApiResponseSchemaWrapper](docs/Model/GetActualAppliedServicesApiResponseSchemaWrapper.md)
 - [GetAnnouncementsConcurrencyInfoItemSchema](docs/Model/GetAnnouncementsConcurrencyInfoItemSchema.md)
 - [GetAnnouncementsConcurrencyInfoResponseSchema](docs/Model/GetAnnouncementsConcurrencyInfoResponseSchema.md)
 - [GetAnnouncementsConcurrencyInfoResponseSchemaWrapper](docs/Model/GetAnnouncementsConcurrencyInfoResponseSchemaWrapper.md)
 - [GetCallsReportForAgencyResponseSchema](docs/Model/GetCallsReportForAgencyResponseSchema.md)
 - [GetCallsReportForAgencyResponseSchemaWrapper](docs/Model/GetCallsReportForAgencyResponseSchemaWrapper.md)
 - [GetEstimationAndBtiResponseSchema](docs/Model/GetEstimationAndBtiResponseSchema.md)
 - [GetEstimationAndBtiResponseSchemaWrapper](docs/Model/GetEstimationAndBtiResponseSchemaWrapper.md)
 - [GetModerationComplaintResponseItemSchema](docs/Model/GetModerationComplaintResponseItemSchema.md)
 - [GetModerationComplaintResponseSchema](docs/Model/GetModerationComplaintResponseSchema.md)
 - [GetModerationComplaintResponseSchemaWrapper](docs/Model/GetModerationComplaintResponseSchemaWrapper.md)
 - [GetUserNotificationsApiResponseSchema](docs/Model/GetUserNotificationsApiResponseSchema.md)
 - [GetUserNotificationsApiResponseSchemaWrapper](docs/Model/GetUserNotificationsApiResponseSchemaWrapper.md)
 - [ImageReportItemResponseSchema](docs/Model/ImageReportItemResponseSchema.md)
 - [ImageReportResponseSchema](docs/Model/ImageReportResponseSchema.md)
 - [ImageReportResponseSchemaWrapper](docs/Model/ImageReportResponseSchemaWrapper.md)
 - [OfferAppliedServiceModelSchema](docs/Model/OfferAppliedServiceModelSchema.md)
 - [OfferAppliedServicesModelSchema](docs/Model/OfferAppliedServicesModelSchema.md)
 - [OfferCoverageResponseSchema](docs/Model/OfferCoverageResponseSchema.md)
 - [OfferCoverageResponseSchemaWrapper](docs/Model/OfferCoverageResponseSchemaWrapper.md)
 - [OffersCoverageStatsByDaysSchema](docs/Model/OffersCoverageStatsByDaysSchema.md)
 - [OffersStatsSchema](docs/Model/OffersStatsSchema.md)
 - [OffersViewsStatsByDaysSchema](docs/Model/OffersViewsStatsByDaysSchema.md)
 - [OperationByUserModelSchema](docs/Model/OperationByUserModelSchema.md)
 - [OperationsByUserListResponseSchema](docs/Model/OperationsByUserListResponseSchema.md)
 - [OperationsByUserListResponseSchemaWrapper](docs/Model/OperationsByUserListResponseSchemaWrapper.md)
 - [OrderInfoResponseSchema](docs/Model/OrderInfoResponseSchema.md)
 - [OrderInfoResponseSchemaWrapper](docs/Model/OrderInfoResponseSchemaWrapper.md)
 - [SaleRoomsStatSchema](docs/Model/SaleRoomsStatSchema.md)
 - [StatsByOfferIdByDaysResponseSchema](docs/Model/StatsByOfferIdByDaysResponseSchema.md)
 - [StatsByOfferIdByDaysResponseSchemaWrapper](docs/Model/StatsByOfferIdByDaysResponseSchemaWrapper.md)
 - [StatsByOfferIdsForAllTimeResponseSchema](docs/Model/StatsByOfferIdsForAllTimeResponseSchema.md)
 - [StatsByOfferIdsForAllTimeResponseSchemaWrapper](docs/Model/StatsByOfferIdsForAllTimeResponseSchemaWrapper.md)
 - [UnloadReportResponseSchema](docs/Model/UnloadReportResponseSchema.md)
 - [UnloadReportResponseSchemaWrapper](docs/Model/UnloadReportResponseSchemaWrapper.md)
 - [UserNotificationsApiItemSchema](docs/Model/UserNotificationsApiItemSchema.md)


## Documentation For Authorization

 All endpoints do not require authorization.


## Author

import@cian.ru