chore: sdk update · hostinger/api-php-sdk@169fcee · GitHub
Skip to content

Commit 169fcee

Browse files
chore: sdk update
1 parent 24af285 commit 169fcee

1,304 files changed

Lines changed: 3339 additions & 1280 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 9 additions & 0 deletions

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "hostinger/api-php-sdk",
3-
"version": "1.64.0",
3+
"version": "1.65.0",
44
"description": "Hostinger API PHP SDK",
55
"keywords": [
66
"hostinger",
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Hostinger\AgentReadinessChecksApi
2+
3+
All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path.
4+
5+
| Method | HTTP request | Description |
6+
| ------------- | ------------- | ------------- |
7+
| [**listChecksV1()**](AgentReadinessChecksApi.md#listChecksV1) | **GET** /api/agent-readiness/v1/checks | List checks |
8+
9+
10+
## `listChecksV1()`
11+
12+
```php
13+
listChecksV1(): \Hostinger\Model\AgentReadinessV1ChecksCheckResource[]
14+
```
15+
16+
List checks
17+
18+
List every check an agent readiness scan runs, with its name, category and weight.\\n Use it to show the human-readable name of each `check_id` in a scan's results.
19+
20+
### Example
21+
22+
```php
23+
<?php
24+
require_once(__DIR__ . '/vendor/autoload.php');
25+
26+
27+
// Configure Bearer authorization: apiToken
28+
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
29+
30+
31+
$apiInstance = new Hostinger\Api\AgentReadinessChecksApi(config: $config);
32+
33+
try {
34+
$result = $apiInstance->listChecksV1();
35+
print_r($result);
36+
} catch (Exception $e) {
37+
echo 'Exception when calling AgentReadinessChecksApi->listChecksV1: ', $e->getMessage(), PHP_EOL;
38+
}
39+
```
40+
41+
### Parameters
42+
43+
This endpoint does not need any parameter.
44+
45+
### Return type
46+
47+
[**\Hostinger\Model\AgentReadinessV1ChecksCheckResource[]**](../Model/AgentReadinessV1ChecksCheckResource.md)
48+
49+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
50+
[[Back to Model list]](../../README.md#models)
51+
[[Back to README]](../../README.md)

‎docs/Api/AgentReadinessScansApi.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Hostinger\AgentReadinessScansApi
2+
3+
All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path.
4+
5+
| Method | HTTP request | Description |
6+
| ------------- | ------------- | ------------- |
7+
| [**getWebsiteScanV1()**](AgentReadinessScansApi.md#getWebsiteScanV1) | **GET** /api/agent-readiness/v1/scans/{domain} | Get website scan |
8+
| [**runWebsiteScanV1()**](AgentReadinessScansApi.md#runWebsiteScanV1) | **POST** /api/agent-readiness/v1/scans | Run website scan |
9+
10+
11+
## `getWebsiteScanV1()`
12+
13+
```php
14+
getWebsiteScanV1($domain): \Hostinger\Model\AgentReadinessV1ScansScanResource
15+
```
16+
17+
Get website scan
18+
19+
Get the latest agent readiness scan of a website.\\n Scans started with the `Run website scan` operation are asynchronous. While the status is `pending`, the result fields are null; wait a few seconds and call this operation again until the status is `completed` or `failed`. A `failed` scan is not retried; run the scan again.\\n A completed scan has a 0-100 score, a letter grade, a score per category, and the result of every check with the evidence found and how to fix it. Check names are listed by the `List checks` operation.\\n Returns 404 when the domain has never been scanned; use the `Run website scan` operation first.
20+
21+
### Example
22+
23+
```php
24+
<?php
25+
require_once(__DIR__ . '/vendor/autoload.php');
26+
27+
28+
// Configure Bearer authorization: apiToken
29+
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
30+
31+
32+
$apiInstance = new Hostinger\Api\AgentReadinessScansApi(config: $config);
33+
$domain = example.com; // string | Domain name the scan was run for
34+
35+
try {
36+
$result = $apiInstance->getWebsiteScanV1($domain);
37+
print_r($result);
38+
} catch (Exception $e) {
39+
echo 'Exception when calling AgentReadinessScansApi->getWebsiteScanV1: ', $e->getMessage(), PHP_EOL;
40+
}
41+
```
42+
43+
### Parameters
44+
45+
| Name | Type | Description | Notes |
46+
| ------------- | ------------- | ------------- | ------------- |
47+
| **domain** | **string**| Domain name the scan was run for | |
48+
49+
### Return type
50+
51+
[**\Hostinger\Model\AgentReadinessV1ScansScanResource**](../Model/AgentReadinessV1ScansScanResource.md)
52+
53+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
54+
[[Back to Model list]](../../README.md#models)
55+
[[Back to README]](../../README.md)
56+
57+
## `runWebsiteScanV1()`
58+
59+
```php
60+
runWebsiteScanV1($agentReadinessV1ScansRunScanRequest): \Hostinger\Model\AgentReadinessV1ScansScanResource
61+
```
62+
63+
Run website scan
64+
65+
Start a scan of how ready a public website is for AI agents to discover, read and act on.\\n Scanning is asynchronous: this operation only starts the scan, and the returned scan is usually `pending` with no results yet. To get the results, poll the `Get website scan` operation with the same domain every few seconds until its status is `completed` or `failed`. The scan itself is limited to 60 seconds, plus any time it waits in the queue. A `failed` scan is not retried; run this operation again.\\n Starting a scan for a domain that already has a pending scan from the last 5 minutes returns that scan instead of starting a new one.
66+
67+
### Example
68+
69+
```php
70+
<?php
71+
require_once(__DIR__ . '/vendor/autoload.php');
72+
73+
74+
// Configure Bearer authorization: apiToken
75+
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
76+
77+
78+
$apiInstance = new Hostinger\Api\AgentReadinessScansApi(config: $config);
79+
$agentReadinessV1ScansRunScanRequest = new \Hostinger\Model\AgentReadinessV1ScansRunScanRequest(); // \Hostinger\Model\AgentReadinessV1ScansRunScanRequest
80+
81+
try {
82+
$result = $apiInstance->runWebsiteScanV1($agentReadinessV1ScansRunScanRequest);
83+
print_r($result);
84+
} catch (Exception $e) {
85+
echo 'Exception when calling AgentReadinessScansApi->runWebsiteScanV1: ', $e->getMessage(), PHP_EOL;
86+
}
87+
```
88+
89+
### Parameters
90+
91+
| Name | Type | Description | Notes |
92+
| ------------- | ------------- | ------------- | ------------- |
93+
| **agentReadinessV1ScansRunScanRequest** | [**\Hostinger\Model\AgentReadinessV1ScansRunScanRequest**](../Model/AgentReadinessV1ScansRunScanRequest.md)| | |
94+
95+
### Return type
96+
97+
[**\Hostinger\Model\AgentReadinessV1ScansScanResource**](../Model/AgentReadinessV1ScansScanResource.md)
98+
99+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
100+
[[Back to Model list]](../../README.md#models)
101+
[[Back to README]](../../README.md)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# # AgentReadinessV1ChecksCheckResource
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **string** | Check ID, as used by &#x60;check_id&#x60; in scan results |
8+
**name** | **string** | Human-readable check name |
9+
**category** | **string** | Category the check belongs to |
10+
**categoryLabel** | **string** | Human-readable category name |
11+
**weight** | **int** | Points this check can earn |
12+
13+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# # AgentReadinessV1ScansCategoriesResource
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**crawlPermission** | [**\Hostinger\Model\AgentReadinessV1ScansCategoryScoreResource**](AgentReadinessV1ScansCategoryScoreResource.md) | |
8+
**findability** | [**\Hostinger\Model\AgentReadinessV1ScansCategoryScoreResource**](AgentReadinessV1ScansCategoryScoreResource.md) | |
9+
**readability** | [**\Hostinger\Model\AgentReadinessV1ScansCategoryScoreResource**](AgentReadinessV1ScansCategoryScoreResource.md) | |
10+
**structuredMeaning** | [**\Hostinger\Model\AgentReadinessV1ScansCategoryScoreResource**](AgentReadinessV1ScansCategoryScoreResource.md) | |
11+
**commercialLegibility** | [**\Hostinger\Model\AgentReadinessV1ScansCategoryScoreResource**](AgentReadinessV1ScansCategoryScoreResource.md) | |
12+
**agentNativeContent** | [**\Hostinger\Model\AgentReadinessV1ScansCategoryScoreResource**](AgentReadinessV1ScansCategoryScoreResource.md) | |
13+
**agentInteraction** | [**\Hostinger\Model\AgentReadinessV1ScansCategoryScoreResource**](AgentReadinessV1ScansCategoryScoreResource.md) | |
14+
15+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# # AgentReadinessV1ScansCategoryScoreResource
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**score** | **int** | Points this category contributes to the 0-100 total score |
8+
**weight** | **int** | Maximum points this category can contribute |
9+
**earned** | **int** | Points earned by the counted checks in this category |
10+
**possible** | **int** | Points possible for the counted checks in this category |
11+
12+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# # AgentReadinessV1ScansCheckResultResource
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**checkId** | **string** | Check ID, as listed by the &#x60;List checks&#x60; operation |
8+
**category** | **string** | Category the check belongs to |
9+
**status** | **string** | Check outcome. &#x60;not_applicable&#x60; and &#x60;error&#x60; checks do not count towards the category score. |
10+
**earned** | **int** | Points earned by this check |
11+
**possible** | **int** | Points this check can earn |
12+
**evidence** | **string** | What the scanner observed |
13+
**fix** | **string** | How to improve the result, or null when there is nothing to fix |
14+
15+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# # AgentReadinessV1ScansRunScanRequest
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**domain** | **string** | Domain name or full URL of the website to scan. Only the host is used. |
8+
9+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Lines changed: 19 additions & 0 deletions

0 commit comments

Comments
 (0)