From 426bde5fa3bd751fcc7b75f8215e3a5c6f4c209c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20R=C3=A4ni?= Date: Wed, 9 Jan 2019 16:18:41 +0200 Subject: [PATCH] Is blacklisted (#5) * Generate isBlacklisted * Artifact version bump * Add example to readme --- README.md | 8 + composer.json | 4 +- docs/Api/BlacklistApi.md | 59 ++++++- gen-config.json | 2 +- lib/Api/BlacklistApi.php | 262 +++++++++++++++++++++++++++- lib/ApiException.php | 4 +- lib/Configuration.php | 10 +- lib/HeaderSelector.php | 4 +- lib/Model/ErrorItem.php | 4 +- lib/Model/ErrorResponse.php | 4 +- lib/Model/FetchBlacklistSuccess.php | 4 +- lib/Model/ModelInterface.php | 4 +- lib/Model/NumberToBlacklist.php | 4 +- lib/Model/ResponseErrorCode.php | 4 +- lib/Model/ResponseErrorTitle.php | 4 +- lib/ObjectSerializer.php | 4 +- 16 files changed, 348 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 03a93e1..d9abd4a 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,13 @@ try { // echo 'Exception when calling addToBlacklist: ', $e->getMessage(), PHP_EOL; // } +// try { +// $apiInstance->isBlacklisted('+37255555555'); +// } catch (Exception $e) { +// echo 'Exception when calling isBlacklisted: ', $e->getMessage(), PHP_EOL; +// } + + // try { // $apiInstance->removeFromBlacklist('+37255555555'); // } catch (Exception $e) { @@ -96,6 +103,7 @@ Class | Method | HTTP request | ------------ | ------------- | ------------- | *BlacklistApi* | [**addToBlacklist**](docs/Api/BlacklistApi.md#addtoblacklist) | **POST** /phonebook/blacklist | *BlacklistApi* | [**fetchBlacklist**](docs/Api/BlacklistApi.md#fetchblacklist) | **GET** /phonebook/blacklist | +*BlacklistApi* | [**isBlacklisted**](docs/Api/BlacklistApi.md#isBlacklisted) | **GET** /phonebook/blacklist/{phone_number} | *BlacklistApi* | [**removeFromBlacklist**](docs/Api/BlacklistApi.md#removefromblacklist) | **DELETE** /phonebook/blacklist/{phone_number} | diff --git a/composer.json b/composer.json index a1d9cff..011edb2 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "messente/messente-phonebook-php", - "version": "0.1.0", - "description": "", + "version": "0.2.0", + "description": "RESTful API for Messente phonebook", "keywords": [ "openapitools", "openapi-generator", diff --git a/docs/Api/BlacklistApi.md b/docs/Api/BlacklistApi.md index f10ea59..eefcd80 100644 --- a/docs/Api/BlacklistApi.md +++ b/docs/Api/BlacklistApi.md @@ -6,6 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**addToBlacklist**](BlacklistApi.md#addToBlacklist) | **POST** /phonebook/blacklist | [**fetchBlacklist**](BlacklistApi.md#fetchBlacklist) | **GET** /phonebook/blacklist | +[**isBlacklisted**](BlacklistApi.md#isBlacklisted) | **GET** /phonebook/blacklist/{phone_number} | [**removeFromBlacklist**](BlacklistApi.md#removeFromBlacklist) | **DELETE** /phonebook/blacklist/{phone_number} | @@ -114,6 +115,60 @@ This endpoint does not need any parameter. [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +# **isBlacklisted** +> isBlacklisted($phoneNumber) + + + +Checks if a phone number is blacklisted. + +### Example +```php +setUsername('YOUR_USERNAME') + ->setPassword('YOUR_PASSWORD'); + +$apiInstance = new Messente\Phonebook\Api\BlacklistApi( + // 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 +); +$phoneNumber = 'phoneNumber_example'; // string | A phone number + +try { + $apiInstance->isBlacklisted($phoneNumber); +} catch (Exception $e) { + echo 'Exception when calling BlacklistApi->isBlacklisted: ', $e->getMessage(), PHP_EOL; +} +?> +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **phoneNumber** | **string**| A phone number | + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + # **removeFromBlacklist** > removeFromBlacklist($phoneNumber) @@ -137,7 +192,7 @@ $apiInstance = new Messente\Phonebook\Api\BlacklistApi( new GuzzleHttp\Client(), $config ); -$phoneNumber = 'phoneNumber_example'; // string | The phone number to be deleted +$phoneNumber = 'phoneNumber_example'; // string | A phone number try { $apiInstance->removeFromBlacklist($phoneNumber); @@ -151,7 +206,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **phoneNumber** | **string**| The phone number to be deleted | + **phoneNumber** | **string**| A phone number | ### Return type diff --git a/gen-config.json b/gen-config.json index 1e184d9..033dca0 100644 --- a/gen-config.json +++ b/gen-config.json @@ -1,5 +1,5 @@ { - "artifactVersion": "0.1.0", + "artifactVersion": "0.2.0", "variableNamingConvention": "camelCase", "gitRepoId": "messente-phonebook-php", "gitUserId": "messente", diff --git a/lib/Api/BlacklistApi.php b/lib/Api/BlacklistApi.php index 61ffe61..fb609ee 100644 --- a/lib/Api/BlacklistApi.php +++ b/lib/Api/BlacklistApi.php @@ -14,10 +14,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** @@ -631,10 +631,258 @@ protected function fetchBlacklistRequest() ); } + /** + * Operation isBlacklisted + * + * @param string $phoneNumber A phone number (required) + * + * @throws \Messente\Phonebook\ApiException on non-2xx response + * @throws \InvalidArgumentException + * @return void + */ + public function isBlacklisted($phoneNumber) + { + $this->isBlacklistedWithHttpInfo($phoneNumber); + } + + /** + * Operation isBlacklistedWithHttpInfo + * + * @param string $phoneNumber A phone number (required) + * + * @throws \Messente\Phonebook\ApiException on non-2xx response + * @throws \InvalidArgumentException + * @return array of null, HTTP status code, HTTP response headers (array of strings) + */ + public function isBlacklistedWithHttpInfo($phoneNumber) + { + $request = $this->isBlacklistedRequest($phoneNumber); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + $e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $response->getBody() + ); + } + + return [null, $statusCode, $response->getHeaders()]; + + } catch (ApiException $e) { + switch ($e->getCode()) { + case 400: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Messente\Phonebook\Model\ErrorResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + case 401: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Messente\Phonebook\Model\ErrorResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + case 404: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Messente\Phonebook\Model\ErrorResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation isBlacklistedAsync + * + * + * + * @param string $phoneNumber A phone number (required) + * + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Promise\PromiseInterface + */ + public function isBlacklistedAsync($phoneNumber) + { + return $this->isBlacklistedAsyncWithHttpInfo($phoneNumber) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation isBlacklistedAsyncWithHttpInfo + * + * + * + * @param string $phoneNumber A phone number (required) + * + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Promise\PromiseInterface + */ + public function isBlacklistedAsyncWithHttpInfo($phoneNumber) + { + $returnType = ''; + $request = $this->isBlacklistedRequest($phoneNumber); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + return [null, $response->getStatusCode(), $response->getHeaders()]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + $response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'isBlacklisted' + * + * @param string $phoneNumber A phone number (required) + * + * @throws \InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request + */ + protected function isBlacklistedRequest($phoneNumber) + { + // verify the required parameter 'phoneNumber' is set + if ($phoneNumber === null || (is_array($phoneNumber) && count($phoneNumber) === 0)) { + throw new \InvalidArgumentException( + 'Missing the required parameter $phoneNumber when calling isBlacklisted' + ); + } + + $resourcePath = '/phonebook/blacklist/{phone_number}'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + + // path params + if ($phoneNumber !== null) { + $resourcePath = str_replace( + '{' . 'phone_number' . '}', + ObjectSerializer::toPathValue($phoneNumber), + $resourcePath + ); + } + + // body params + $_tempBody = null; + + if ($multipart) { + $headers = $this->headerSelector->selectHeadersForMultipart( + ['application/json'] + ); + } else { + $headers = $this->headerSelector->selectHeaders( + ['application/json'], + [] + ); + } + + // for model (json/xml) + if (isset($_tempBody)) { + // $_tempBody is the method argument, if present + if ($headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody)); + } else { + $httpBody = $_tempBody; + } + } elseif (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValue + ]; + } + // for HTTP post (form) + $httpBody = new MultipartStream($multipartContents); + + } elseif ($headers['Content-Type'] === 'application/json') { + $httpBody = \GuzzleHttp\json_encode($formParams); + + } else { + // for HTTP post (form) + $httpBody = \GuzzleHttp\Psr7\build_query($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if ($this->config->getUsername() !== null || $this->config->getPassword() !== null) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ":" . $this->config->getPassword()); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $query = \GuzzleHttp\Psr7\build_query($queryParams); + return new Request( + 'GET', + $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + /** * Operation removeFromBlacklist * - * @param string $phoneNumber The phone number to be deleted (required) + * @param string $phoneNumber A phone number (required) * * @throws \Messente\Phonebook\ApiException on non-2xx response * @throws \InvalidArgumentException @@ -648,7 +896,7 @@ public function removeFromBlacklist($phoneNumber) /** * Operation removeFromBlacklistWithHttpInfo * - * @param string $phoneNumber The phone number to be deleted (required) + * @param string $phoneNumber A phone number (required) * * @throws \Messente\Phonebook\ApiException on non-2xx response * @throws \InvalidArgumentException @@ -732,7 +980,7 @@ public function removeFromBlacklistWithHttpInfo($phoneNumber) * * * - * @param string $phoneNumber The phone number to be deleted (required) + * @param string $phoneNumber A phone number (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface @@ -752,7 +1000,7 @@ function ($response) { * * * - * @param string $phoneNumber The phone number to be deleted (required) + * @param string $phoneNumber A phone number (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface @@ -788,7 +1036,7 @@ function ($exception) { /** * Create request for operation 'removeFromBlacklist' * - * @param string $phoneNumber The phone number to be deleted (required) + * @param string $phoneNumber A phone number (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request diff --git a/lib/ApiException.php b/lib/ApiException.php index 53258bf..744f16d 100644 --- a/lib/ApiException.php +++ b/lib/ApiException.php @@ -14,10 +14,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** diff --git a/lib/Configuration.php b/lib/Configuration.php index bb98e4f..312c78e 100644 --- a/lib/Configuration.php +++ b/lib/Configuration.php @@ -14,10 +14,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** @@ -88,7 +88,7 @@ class Configuration * * @var string */ - protected $userAgent = 'OpenAPI-Generator/0.1.0/PHP'; + protected $userAgent = 'OpenAPI-Generator/0.2.0/PHP'; /** * Debug switch (default set to false) @@ -396,8 +396,8 @@ public static function toDebugReport() $report = 'PHP SDK (Messente\Phonebook) Debug Report:' . PHP_EOL; $report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL; - $report .= ' OpenAPI Spec Version: 0.0.1' . PHP_EOL; - $report .= ' SDK Package Version: 0.1.0' . PHP_EOL; + $report .= ' OpenAPI Spec Version: 0.0.3' . PHP_EOL; + $report .= ' SDK Package Version: 0.2.0' . PHP_EOL; $report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL; return $report; diff --git a/lib/HeaderSelector.php b/lib/HeaderSelector.php index 497e0e3..e1fa999 100644 --- a/lib/HeaderSelector.php +++ b/lib/HeaderSelector.php @@ -14,10 +14,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** diff --git a/lib/Model/ErrorItem.php b/lib/Model/ErrorItem.php index aada23b..0a7bc1e 100644 --- a/lib/Model/ErrorItem.php +++ b/lib/Model/ErrorItem.php @@ -15,10 +15,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** diff --git a/lib/Model/ErrorResponse.php b/lib/Model/ErrorResponse.php index 4b7b444..fe50f91 100644 --- a/lib/Model/ErrorResponse.php +++ b/lib/Model/ErrorResponse.php @@ -15,10 +15,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** diff --git a/lib/Model/FetchBlacklistSuccess.php b/lib/Model/FetchBlacklistSuccess.php index 76c3535..6a5519d 100644 --- a/lib/Model/FetchBlacklistSuccess.php +++ b/lib/Model/FetchBlacklistSuccess.php @@ -15,10 +15,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** diff --git a/lib/Model/ModelInterface.php b/lib/Model/ModelInterface.php index 850b504..97c3b0d 100644 --- a/lib/Model/ModelInterface.php +++ b/lib/Model/ModelInterface.php @@ -15,10 +15,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** diff --git a/lib/Model/NumberToBlacklist.php b/lib/Model/NumberToBlacklist.php index 316da04..9f50470 100644 --- a/lib/Model/NumberToBlacklist.php +++ b/lib/Model/NumberToBlacklist.php @@ -15,10 +15,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** diff --git a/lib/Model/ResponseErrorCode.php b/lib/Model/ResponseErrorCode.php index e8bc6ef..6cbb7c7 100644 --- a/lib/Model/ResponseErrorCode.php +++ b/lib/Model/ResponseErrorCode.php @@ -15,10 +15,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** diff --git a/lib/Model/ResponseErrorTitle.php b/lib/Model/ResponseErrorTitle.php index 951426a..c0bb975 100644 --- a/lib/Model/ResponseErrorTitle.php +++ b/lib/Model/ResponseErrorTitle.php @@ -15,10 +15,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /** diff --git a/lib/ObjectSerializer.php b/lib/ObjectSerializer.php index 80b9be8..0582fc9 100644 --- a/lib/ObjectSerializer.php +++ b/lib/ObjectSerializer.php @@ -15,10 +15,10 @@ * * RESTful API for Messente phonebook * - * OpenAPI spec version: 0.0.1 + * OpenAPI spec version: 0.0.3 * Contact: messente@messente.com * Generated by: https://openapi-generator.tech - * OpenAPI Generator version: 3.3.3 + * OpenAPI Generator version: 3.3.4 */ /**