# OpenAPIClient-php

All timeouts are set in seconds with nanosecond precision. For example, 1.505402 is 1 second, 505 milliseconds and 402 microseconds.



## Installation & Usage

### Requirements

PHP 7.2 and later.

### Composer

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

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

Then run `composer install`

### Manual Installation

Download the files and include `autoload.php`:

```php
<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
```

## Getting Started

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

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



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

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

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


$apiInstance = new OpenAPI\Client\Api\EmailValidationApi(
    // 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
);
$email = 'email_example'; // string
$result_type = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\ResultType(); // \OpenAPI\Client\Model\ResultType | ResultTypeDescription

try {
    $result = $apiInstance->emailValidationSingleValidationGet($email, $result_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailValidationApi->emailValidationSingleValidationGet: ', $e->getMessage(), PHP_EOL;
}

```

## API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EmailValidationApi* | [**emailValidationSingleValidationGet**](docs/Api/EmailValidationApi.md#emailvalidationsinglevalidationget) | **GET** /v1/validation/single/{email} | 
*EmailValidationApi* | [**emailValidationSingleValidationPost**](docs/Api/EmailValidationApi.md#emailvalidationsinglevalidationpost) | **POST** /v1/validation/single | 

## Models

- [CheckIfEmailExistMX](docs/Model/CheckIfEmailExistMX.md)
- [CheckIfEmailExistMisc](docs/Model/CheckIfEmailExistMisc.md)
- [CheckIfEmailExistResult](docs/Model/CheckIfEmailExistResult.md)
- [CheckIfEmailExistSMTP](docs/Model/CheckIfEmailExistSMTP.md)
- [CheckIfEmailExistSyntax](docs/Model/CheckIfEmailExistSyntax.md)
- [EmailRequest](docs/Model/EmailRequest.md)
- [EmailRequestSmtp](docs/Model/EmailRequestSmtp.md)
- [EmailResponse](docs/Model/EmailResponse.md)
- [MailboxvalidatorResult](docs/Model/MailboxvalidatorResult.md)
- [PromptEmailVerificationApiMX](docs/Model/PromptEmailVerificationApiMX.md)
- [PromptEmailVerificationApiResult](docs/Model/PromptEmailVerificationApiResult.md)
- [ResultType](docs/Model/ResultType.md)
- [UnexpectedError](docs/Model/UnexpectedError.md)

## Authorization

### AuthKey

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header



### RapidApiKey

- **Type**: API key
- **API key parameter name**: X-RapidAPI-Key
- **Location**: HTTP header



### RapidApiSecret

- **Type**: API key
- **API key parameter name**: X-RapidAPI-Proxy-Secret
- **Location**: HTTP header


## Tests

To run the tests, use:

```bash
composer install
vendor/bin/phpunit
```

## Author



## About this package

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `0.0.1`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`