Skip to content

feat(sdk): v4.8.0 - Auto-generated from unified API spec #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
quant-sdk wants to merge 1 commit into from
Closed

feat(sdk): v4.8.0 - Auto-generated from unified API spec #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/Api/BackupManagementApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ $apiInstance = new QuantClient\Api\BackupManagementApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$application = 'application_example'; // string | The application ID
$environment = 'environment_example'; // string | The environment ID
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID
$type = 'type_example'; // string | The backup type
$create_backup_request = new \QuantClient\Model\CreateBackupRequest(); // \QuantClient\Model\CreateBackupRequest

Expand Down Expand Up @@ -101,9 +101,9 @@ $apiInstance = new QuantClient\Api\BackupManagementApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$application = 'application_example'; // string | The application ID
$environment = 'environment_example'; // string | The environment ID
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID
$type = 'type_example'; // string | The backup type
$backup_id = 'backup_id_example'; // string | The backup ID

Expand Down Expand Up @@ -167,9 +167,9 @@ $apiInstance = new QuantClient\Api\BackupManagementApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$application = 'application_example'; // string | The application ID
$environment = 'environment_example'; // string | The environment ID
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID
$type = 'type_example'; // string | The backup type
$backup_id = 'backup_id_example'; // string | The backup ID

Expand Down Expand Up @@ -235,9 +235,9 @@ $apiInstance = new QuantClient\Api\BackupManagementApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$application = 'application_example'; // string | The application ID
$environment = 'environment_example'; // string | The environment ID
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID
$type = 'type_example'; // string | The backup type
$order = 'desc'; // string | Sort order for backups by creation date (asc = oldest first, desc = newest first)
$limit = 50; // int | Maximum number of backups to return (max 100)
Expand Down
14 changes: 7 additions & 7 deletions docs/Api/CommandsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ $apiInstance = new QuantClient\Api\CommandsApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$environment = 'environment_example'; // string | The environment ID
$organisation = test-org; // string | The organisation ID
$environment = test-env; // string | The environment ID
$create_command_request = new \QuantClient\Model\CreateCommandRequest(); // \QuantClient\Model\CreateCommandRequest

try {
Expand Down Expand Up @@ -96,9 +96,9 @@ $apiInstance = new QuantClient\Api\CommandsApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$environment = 'environment_example'; // string | The environment ID
$command = 'command_example'; // string | The command ID
$organisation = test-org; // string | The organisation ID
$environment = test-env; // string | The environment ID
$command = test-cmd; // string | The command ID

try {
$result = $apiInstance->getCommand($organisation, $environment, $command);
Expand Down Expand Up @@ -158,8 +158,8 @@ $apiInstance = new QuantClient\Api\CommandsApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$environment = 'environment_example'; // string | The environment ID
$organisation = test-org; // string | The organisation ID
$environment = test-env; // string | The environment ID

try {
$result = $apiInstance->listCommands($organisation, $environment);
Expand Down
14 changes: 7 additions & 7 deletions docs/Api/ComposeApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ $apiInstance = new QuantClient\Api\ComposeApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$application = 'application_example'; // string | The application ID
$environment = 'environment_example'; // string | The environment ID
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID

try {
$result = $apiInstance->getEnvironmentCompose($organisation, $application, $environment);
Expand Down Expand Up @@ -98,9 +98,9 @@ $apiInstance = new QuantClient\Api\ComposeApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$application = 'application_example'; // string | The application ID
$environment = 'environment_example'; // string | The environment ID
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID
$patch_environment_compose_request = new \QuantClient\Model\PatchEnvironmentComposeRequest(); // \QuantClient\Model\PatchEnvironmentComposeRequest | Partial compose definition updates. All fields are optional.

try {
Expand Down Expand Up @@ -164,7 +164,7 @@ $apiInstance = new QuantClient\Api\ComposeApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$organisation = test-org; // string | The organisation ID
$validate_compose_request = new \QuantClient\Model\ValidateComposeRequest(); // \QuantClient\Model\ValidateComposeRequest | The docker-compose.yml file content. Can be sent as raw YAML string or as a JSON wrapper containing both yamlContent (string) and imageSuffix (string) fields. Query parameter imageSuffix takes precedence if both are provided.
$image_suffix = pr-456; // string | Optional. Image tag suffix to apply during translation. Transforms internal image tags to consistent '{containerName}-{suffix}' format (e.g., 'nginx-pr-456'). External images are left unchanged. Useful for feature branch deployments.

Expand Down
14 changes: 7 additions & 7 deletions docs/Api/ContainersApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ $apiInstance = new QuantClient\Api\ContainersApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$application = 'application_example'; // string | The application ID
$environment = 'environment_example'; // string | The environment ID
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID

try {
$apiInstance->listContainers($organisation, $application, $environment);
Expand Down Expand Up @@ -94,10 +94,10 @@ $apiInstance = new QuantClient\Api\ContainersApi(
new GuzzleHttp\Client(),
$config
);
$organisation = 'organisation_example'; // string | The organisation ID
$application = 'application_example'; // string | The application ID
$environment = 'environment_example'; // string | The environment ID
$container = 'container_example'; // string | The container ID
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID
$container = test-container; // string | The container ID
$container2 = new \QuantClient\Model\Container(); // \QuantClient\Model\Container

try {
Expand Down
6 changes: 3 additions & 3 deletions docs/Api/CrawlerSchedulesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,9 +229,9 @@ $apiInstance = new QuantClient\Api\CrawlerSchedulesApi(
new GuzzleHttp\Client(),
$config
);
$organization = 'organization_example'; // string
$project = 'project_example'; // string
$crawler = 'crawler_example'; // string
$organization = test-org; // string
$project = test-project; // string
$crawler = 00000000-0000-0000-0000-000000000000; // string

try {
$result = $apiInstance->crawlerSchedulesList($organization, $project, $crawler);
Expand Down
59 changes: 29 additions & 30 deletions docs/Api/CrawlersApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ $apiInstance = new QuantClient\Api\CrawlersApi(
new GuzzleHttp\Client(),
$config
);
$organization = 'organization_example'; // string | Organization identifier
$project = 'project_example'; // string | Project identifier
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$v2_crawler_request = new \QuantClient\Model\V2CrawlerRequest(); // \QuantClient\Model\V2CrawlerRequest

try {
Expand Down Expand Up @@ -101,9 +101,9 @@ $apiInstance = new QuantClient\Api\CrawlersApi(
new GuzzleHttp\Client(),
$config
);
$organization = 'organization_example'; // string | Organization identifier
$project = 'project_example'; // string | Project identifier
$crawler = 'crawler_example'; // string
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | The UUID of the crawler

try {
$apiInstance->crawlersDelete($organization, $project, $crawler);
Expand All @@ -118,7 +118,7 @@ try {
| ------------- | ------------- | ------------- | ------------- |
| **organization** | **string**| Organization identifier | |
| **project** | **string**| Project identifier | |
| **crawler** | **string**| | |
| **crawler** | **string**| The UUID of the crawler | |

### Return type

Expand Down Expand Up @@ -162,10 +162,10 @@ $apiInstance = new QuantClient\Api\CrawlersApi(
new GuzzleHttp\Client(),
$config
);
$organization = 'organization_example'; // string | Organization identifier
$project = 'project_example'; // string | Project identifier
$crawler = 'crawler_example'; // string | Crawler identifier
$run_id = 56; // int | Run identifier
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | Crawler identifier
$run_id = 1; // int | Run identifier

try {
$result = $apiInstance->crawlersGetRunById($organization, $project, $crawler, $run_id);
Expand Down Expand Up @@ -226,9 +226,9 @@ $apiInstance = new QuantClient\Api\CrawlersApi(
new GuzzleHttp\Client(),
$config
);
$organization = 'organization_example'; // string | Organization identifier
$project = 'project_example'; // string | Project identifier
$crawler = 'crawler_example'; // string | Crawler identifier
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | Crawler identifier

try {
$result = $apiInstance->crawlersGetRuns($organization, $project, $crawler);
Expand Down Expand Up @@ -266,7 +266,7 @@ try {
## `crawlersList()`

```php
crawlersList($organization, $project): \QuantClient\Model\V2Crawler[]
crawlersList($organization, $project)
```

List crawlers for the project
Expand All @@ -288,12 +288,11 @@ $apiInstance = new QuantClient\Api\CrawlersApi(
new GuzzleHttp\Client(),
$config
);
$organization = 'organization_example'; // string | Organization identifier
$project = 'project_example'; // string | Project identifier
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier

try {
$result = $apiInstance->crawlersList($organization, $project);
print_r($result);
$apiInstance->crawlersList($organization, $project);
} catch (Exception $e) {
echo 'Exception when calling CrawlersApi->crawlersList: ', $e->getMessage(), PHP_EOL;
}
Expand All @@ -308,7 +307,7 @@ try {

### Return type

[**\QuantClient\Model\V2Crawler[]**](../Model/V2Crawler.md)
void (empty response body)

### Authorization

Expand Down Expand Up @@ -348,9 +347,9 @@ $apiInstance = new QuantClient\Api\CrawlersApi(
new GuzzleHttp\Client(),
$config
);
$organization = 'organization_example'; // string | Organization identifier
$project = 'project_example'; // string | Project identifier
$crawler = 'crawler_example'; // string
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | The UUID of the crawler

try {
$result = $apiInstance->crawlersRead($organization, $project, $crawler);
Expand All @@ -366,7 +365,7 @@ try {
| ------------- | ------------- | ------------- | ------------- |
| **organization** | **string**| Organization identifier | |
| **project** | **string**| Project identifier | |
| **crawler** | **string**| | |
| **crawler** | **string**| The UUID of the crawler | |

### Return type

Expand Down Expand Up @@ -410,9 +409,9 @@ $apiInstance = new QuantClient\Api\CrawlersApi(
new GuzzleHttp\Client(),
$config
);
$organization = 'organization_example'; // string | Organization identifier
$project = 'project_example'; // string | Project identifier
$crawler = 'crawler_example'; // string | Crawler identifier
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | Crawler identifier
$crawlers_run_request = new \QuantClient\Model\CrawlersRunRequest(); // \QuantClient\Model\CrawlersRunRequest

try {
Expand Down Expand Up @@ -474,9 +473,9 @@ $apiInstance = new QuantClient\Api\CrawlersApi(
new GuzzleHttp\Client(),
$config
);
$organization = 'organization_example'; // string | Organization identifier
$project = 'project_example'; // string | Project identifier
$crawler = 'crawler_example'; // string
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | The UUID of the crawler
$v2_crawler_request = new \QuantClient\Model\V2CrawlerRequest(); // \QuantClient\Model\V2CrawlerRequest

try {
Expand All @@ -493,7 +492,7 @@ try {
| ------------- | ------------- | ------------- | ------------- |
| **organization** | **string**| Organization identifier | |
| **project** | **string**| Project identifier | |
| **crawler** | **string**| | |
| **crawler** | **string**| The UUID of the crawler | |
| **v2_crawler_request** | [**\QuantClient\Model\V2CrawlerRequest**](../Model/V2CrawlerRequest.md)| | |

### Return type
Expand Down
Loading
Loading