> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yasmina.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Php

# Yasminaai PHP Library

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github\&utm_medium=github\&utm_campaign=readme\&utm_source=https%3A%2F%2Fgithub.com%2FYasminaAI%2Fmotor-php-sdk)
[![php shield](https://img.shields.io/badge/php-packagist-pink)](https://packagist.org/packages/yasminaai/yasminaai)

The Yasminaai PHP library provides convenient access to the Yasminaai APIs from PHP.

## Table of Contents

* [Requirements](#requirements)
* [Installation](#installation)
* [Usage](#usage)
* [Environments](#environments)
* [Exception Handling](#exception-handling)
* [Advanced](#advanced)
  * [Custom Client](#custom-client)
  * [Retries](#retries)
  * [Timeouts](#timeouts)
* [Contributing](#contributing)

## Requirements

This SDK requires PHP ^8.1.

## Installation

```sh theme={null}
composer require yasminaai/yasminaai
```

## Usage

Instantiate and use the client with the following:

```php theme={null}
<?php

namespace Example;

use Yasminaai\YasminaaiClient;
use Yasminaai\Quotes\Requests\PostQuoteRequestsRequest;
use DateTime;

$client = new YasminaaiClient(
    token: '<token>',
);
$client->quotes->requestQuotes(
    new PostQuoteRequestsRequest([
        'otp' => '123456',
        'ownerId' => 'owner_id',
        'phone' => 'phone',
        'birthdate' => new DateTime('2023-01-15'),
        'carEstimatedCost' => 1.1,
    ]),
);

```

## Environments

This SDK allows you to configure different environments for API requests.

````php theme={null}
The SDK defaults to the `Sandbox` environment. To use a different environment, pass it to the client constructor:

```php
use Yasminaai\YasminaaiClient;
use Yasminaai\Environments;

$client = new YasminaaiClient(
    token: '<YOUR_TOKEN>',
    options: [
        'baseUrl' => Environments::Staging->value
    ]
);
````

Available environments:

* `Environments::Sandbox`
* `Environments::Production`

````

## Exception Handling

When the API returns a non-success status code (4xx or 5xx response), an exception will be thrown.

```php
use Yasminaai\Exceptions\YasminaaiApiException;
use Yasminaai\Exceptions\YasminaaiException;

try {
    $response = $client->quotes->requestQuotes(...);
} catch (YasminaaiApiException $e) {
    echo 'API Exception occurred: ' . $e->getMessage() . "\n";
    echo 'Status Code: ' . $e->getCode() . "\n";
    echo 'Response Body: ' . $e->getBody() . "\n";
    // Optionally, rethrow the exception or handle accordingly.
}
````

## Advanced

### Custom Client

This SDK is built to work with any HTTP client that implements the [PSR-18](https://www.php-fig.org/psr/psr-18/) `ClientInterface`.
By default, if no client is provided, the SDK will use `php-http/discovery` to find an installed HTTP client.
However, you can pass your own client that adheres to `ClientInterface`:

```php theme={null}
use Yasminaai\YasminaaiClient;

// Pass any PSR-18 compatible HTTP client implementation.
// For example, using Guzzle:
$customClient = new \GuzzleHttp\Client([
    'timeout' => 5.0,
]);

$client = new YasminaaiClient(options: [
    'client' => $customClient
]);

// Or using Symfony HttpClient:
// $customClient = (new \Symfony\Component\HttpClient\Psr18Client())
//     ->withOptions(['timeout' => 5.0]);
//
// $client = new YasminaaiClient(options: [
//     'client' => $customClient
// ]);
```

### Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

* [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
* [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
* [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (Internal Server Error)

The `retryStatusCodes` configuration controls which [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) status codes are retried:

* `legacy` (default): Retries `408`, `429`, and all `>= 500`
* `recommended`: Retries `408`, `429`, `502`, `503`, `504` only (excludes `500 Internal Server Error` to avoid retrying non-idempotent failures)

Use the `maxRetries` request option to configure this behavior.

```php theme={null}
$response = $client->quotes->requestQuotes(
    ...,
    options: [
        'maxRetries' => 0 // Override maxRetries at the request level
    ]
);
```

### Timeouts

The SDK defaults to a 30 second timeout. Use the `timeout` option to configure this behavior.

```php theme={null}
$response = $client->quotes->requestQuotes(
    ...,
    options: [
        'timeout' => 3.0 // Override timeout at the request level
    ]
);
```

## Contributing

While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!