feat(sdk): v4.8.0 - Auto-generated from unified API spec [skip ci]

Author: quantcloud[bot]

.openapi-generator/FILES

@@ -1,7 +1,6 @@
 .github/workflows/python.yml
 .gitignore
 .gitlab-ci.yml
-.openapi-generator-ignore
 .travis.yml
 README.md
 docs/AIAgentsApi.md

README.md

@@ -3,7 +3,7 @@ Unified API for QuantCDN Admin and QuantCloud Platform services
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 4.6.0
+- API version: 4.8.0
 - Package version: 1.0.0
 - Generator version: 7.13.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen

docs/BackupManagementApi.md

@@ -46,9 +46,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.BackupManagementApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    application = 'application_example' # str | The application ID
-    environment = 'environment_example' # str | The environment ID
+    organisation = 'test-org' # str | The organisation ID
+    application = 'test-app' # str | The application ID
+    environment = 'test-env' # str | The environment ID
     type = 'type_example' # str | The backup type
     create_backup_request = quantcdn.CreateBackupRequest() # CreateBackupRequest |  (optional)
 
@@ -130,9 +130,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.BackupManagementApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    application = 'application_example' # str | The application ID
-    environment = 'environment_example' # str | The environment ID
+    organisation = 'test-org' # str | The organisation ID
+    application = 'test-app' # str | The application ID
+    environment = 'test-env' # str | The environment ID
     type = 'type_example' # str | The backup type
     backup_id = 'backup_id_example' # str | The backup ID
 
@@ -214,9 +214,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.BackupManagementApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    application = 'application_example' # str | The application ID
-    environment = 'environment_example' # str | The environment ID
+    organisation = 'test-org' # str | The organisation ID
+    application = 'test-app' # str | The application ID
+    environment = 'test-env' # str | The environment ID
     type = 'type_example' # str | The backup type
     backup_id = 'backup_id_example' # str | The backup ID
 
@@ -300,9 +300,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.BackupManagementApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    application = 'application_example' # str | The application ID
-    environment = 'environment_example' # str | The environment ID
+    organisation = 'test-org' # str | The organisation ID
+    application = 'test-app' # str | The application ID
+    environment = 'test-env' # str | The environment ID
     type = 'type_example' # str | The backup type
     order = desc # str | Sort order for backups by creation date (asc = oldest first, desc = newest first) (optional) (default to desc)
     limit = 50 # int | Maximum number of backups to return (max 100) (optional) (default to 50)

docs/CommandsApi.md

@@ -45,8 +45,8 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CommandsApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    environment = 'environment_example' # str | The environment ID
+    organisation = 'test-org' # str | The organisation ID
+    environment = 'test-env' # str | The environment ID
     create_command_request = quantcdn.CreateCommandRequest() # CreateCommandRequest | 
 
     try:
@@ -125,9 +125,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CommandsApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    environment = 'environment_example' # str | The environment ID
-    command = 'command_example' # str | The command ID
+    organisation = 'test-org' # str | The organisation ID
+    environment = 'test-env' # str | The environment ID
+    command = 'test-cmd' # str | The command ID
 
     try:
         # Get a command
@@ -205,8 +205,8 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CommandsApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    environment = 'environment_example' # str | The environment ID
+    organisation = 'test-org' # str | The organisation ID
+    environment = 'test-env' # str | The environment ID
 
     try:
         # Get all commands for an environment

docs/ComposeApi.md

@@ -44,9 +44,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.ComposeApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    application = 'application_example' # str | The application ID
-    environment = 'environment_example' # str | The environment ID
+    organisation = 'test-org' # str | The organisation ID
+    application = 'test-app' # str | The application ID
+    environment = 'test-env' # str | The environment ID
 
     try:
         # Get the compose file for an environment
@@ -128,9 +128,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.ComposeApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    application = 'application_example' # str | The application ID
-    environment = 'environment_example' # str | The environment ID
+    organisation = 'test-org' # str | The organisation ID
+    application = 'test-app' # str | The application ID
+    environment = 'test-env' # str | The environment ID
     patch_environment_compose_request = quantcdn.PatchEnvironmentComposeRequest() # PatchEnvironmentComposeRequest | Partial compose definition updates. All fields are optional.
 
     try:
@@ -215,7 +215,7 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.ComposeApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
+    organisation = 'test-org' # str | The organisation ID
     validate_compose_request = quantcdn.ValidateComposeRequest() # 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' # str | 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. (optional)
 

docs/ContainersApi.md

@@ -42,9 +42,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.ContainersApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    application = 'application_example' # str | The application ID
-    environment = 'environment_example' # str | The environment ID
+    organisation = 'test-org' # str | The organisation ID
+    application = 'test-app' # str | The application ID
+    environment = 'test-env' # str | The environment ID
 
     try:
         # Get the containers in an environment
@@ -121,10 +121,10 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.ContainersApi(api_client)
-    organisation = 'organisation_example' # str | The organisation ID
-    application = 'application_example' # str | The application ID
-    environment = 'environment_example' # str | The environment ID
-    container = 'container_example' # str | The container ID
+    organisation = 'test-org' # str | The organisation ID
+    application = 'test-app' # str | The application ID
+    environment = 'test-env' # str | The environment ID
+    container = 'test-container' # str | The container ID
     container2 = quantcdn.Container() # Container | 
 
     try:

docs/CrawlerSchedulesApi.md

@@ -299,9 +299,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CrawlerSchedulesApi(api_client)
-    organization = 'organization_example' # str | 
-    project = 'project_example' # str | 
-    crawler = 'crawler_example' # str | 
+    organization = 'test-org' # str | 
+    project = 'test-project' # str | 
+    crawler = '00000000-0000-0000-0000-000000000000' # str | 
 
     try:
         # List schedules for a crawler

docs/CrawlersApi.md

@@ -50,8 +50,8 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CrawlersApi(api_client)
-    organization = 'organization_example' # str | Organization identifier
-    project = 'project_example' # str | Project identifier
+    organization = 'test-org' # str | Organization identifier
+    project = 'test-project' # str | Project identifier
     v2_crawler_request = quantcdn.V2CrawlerRequest() # V2CrawlerRequest | 
 
     try:
@@ -131,9 +131,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CrawlersApi(api_client)
-    organization = 'organization_example' # str | Organization identifier
-    project = 'project_example' # str | Project identifier
-    crawler = 'crawler_example' # str | 
+    organization = 'test-org' # str | Organization identifier
+    project = 'test-project' # str | Project identifier
+    crawler = '00000000-0000-0000-0000-000000000000' # str | The UUID of the crawler
 
     try:
         # Delete a crawler
@@ -151,7 +151,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **organization** | **str**| Organization identifier | 
  **project** | **str**| Project identifier | 
- **crawler** | **str**|  | 
+ **crawler** | **str**| The UUID of the crawler | 
 
 ### Return type
 
@@ -211,10 +211,10 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CrawlersApi(api_client)
-    organization = 'organization_example' # str | Organization identifier
-    project = 'project_example' # str | Project identifier
-    crawler = 'crawler_example' # str | Crawler identifier
-    run_id = 56 # int | Run identifier
+    organization = 'test-org' # str | Organization identifier
+    project = 'test-project' # str | Project identifier
+    crawler = '00000000-0000-0000-0000-000000000000' # str | Crawler identifier
+    run_id = 1 # int | Run identifier
 
     try:
         # Get a run by ID
@@ -297,9 +297,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CrawlersApi(api_client)
-    organization = 'organization_example' # str | Organization identifier
-    project = 'project_example' # str | Project identifier
-    crawler = 'crawler_example' # str | Crawler identifier
+    organization = 'test-org' # str | Organization identifier
+    project = 'test-project' # str | Project identifier
+    crawler = '00000000-0000-0000-0000-000000000000' # str | Crawler identifier
 
     try:
         # Get all runs for a crawler
@@ -347,7 +347,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **crawlers_list**
-> List[V2Crawler] crawlers_list(organization, project)
+> crawlers_list(organization, project)
 
 List crawlers for the project
 
@@ -357,7 +357,6 @@ List crawlers for the project
 
 ```python
 import quantcdn
-from quantcdn.models.v2_crawler import V2Crawler
 from quantcdn.rest import ApiException
 from pprint import pprint
 
@@ -381,14 +380,12 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CrawlersApi(api_client)
-    organization = 'organization_example' # str | Organization identifier
-    project = 'project_example' # str | Project identifier
+    organization = 'test-org' # str | Organization identifier
+    project = 'test-project' # str | Project identifier
 
     try:
         # List crawlers for the project
-        api_response = api_instance.crawlers_list(organization, project)
-        print("The response of CrawlersApi->crawlers_list:\n")
-        pprint(api_response)
+        api_instance.crawlers_list(organization, project)
     except Exception as e:
         print("Exception when calling CrawlersApi->crawlers_list: %s\n" % e)
 ```
@@ -405,7 +402,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**List[V2Crawler]**](V2Crawler.md)
+void (empty response body)
 
 ### Authorization
 
@@ -420,7 +417,6 @@ Name | Type | Description  | Notes
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | The request has succeeded. |  -  |
 **400** | The server could not understand the request due to invalid syntax. |  -  |
 **403** | Access is forbidden. |  -  |
 
@@ -461,9 +457,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CrawlersApi(api_client)
-    organization = 'organization_example' # str | Organization identifier
-    project = 'project_example' # str | Project identifier
-    crawler = 'crawler_example' # str | 
+    organization = 'test-org' # str | Organization identifier
+    project = 'test-project' # str | Project identifier
+    crawler = '00000000-0000-0000-0000-000000000000' # str | The UUID of the crawler
 
     try:
         # Get details of a single crawler
@@ -483,7 +479,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **organization** | **str**| Organization identifier | 
  **project** | **str**| Project identifier | 
- **crawler** | **str**|  | 
+ **crawler** | **str**| The UUID of the crawler | 
 
 ### Return type
 
@@ -544,9 +540,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CrawlersApi(api_client)
-    organization = 'organization_example' # str | Organization identifier
-    project = 'project_example' # str | Project identifier
-    crawler = 'crawler_example' # str | Crawler identifier
+    organization = 'test-org' # str | Organization identifier
+    project = 'test-project' # str | Project identifier
+    crawler = '00000000-0000-0000-0000-000000000000' # str | Crawler identifier
     crawlers_run_request = quantcdn.CrawlersRunRequest() # CrawlersRunRequest | 
 
     try:
@@ -631,9 +627,9 @@ configuration = quantcdn.Configuration(
 with quantcdn.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = quantcdn.CrawlersApi(api_client)
-    organization = 'organization_example' # str | Organization identifier
-    project = 'project_example' # str | Project identifier
-    crawler = 'crawler_example' # str | 
+    organization = 'test-org' # str | Organization identifier
+    project = 'test-project' # str | Project identifier
+    crawler = '00000000-0000-0000-0000-000000000000' # str | The UUID of the crawler
     v2_crawler_request = quantcdn.V2CrawlerRequest() # V2CrawlerRequest | 
 
     try:
@@ -654,7 +650,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **organization** | **str**| Organization identifier | 
  **project** | **str**| Project identifier | 
- **crawler** | **str**|  | 
+ **crawler** | **str**| The UUID of the crawler | 
  **v2_crawler_request** | [**V2CrawlerRequest**](V2CrawlerRequest.md)|  | 
 
 ### Return type