Fix Synthetics batch status (#2245)

* Regenerate client from commit 8d63eae4 of spec repo

* pre-commit fixes

---------

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-04 21:14:35.996163",
-            "spec_repo_commit": "08338fd1"
+            "regenerated": "2024-11-05 15:05:42.147981",
+            "spec_repo_commit": "8d63eae4"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-04 21:14:36.014063",
-            "spec_repo_commit": "08338fd1"
+            "regenerated": "2024-11-05 15:05:42.166088",
+            "spec_repo_commit": "8d63eae4"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -14418,7 +14418,7 @@ components:
             $ref: '#/components/schemas/SyntheticsBatchResult'
           type: array
         status:
-          $ref: '#/components/schemas/SyntheticsStatus'
+          $ref: '#/components/schemas/SyntheticsBatchStatus'
       type: object
     SyntheticsBatchResult:
       description: Object with the results of a Synthetic batch.
@@ -14442,7 +14442,7 @@ components:
           format: double
           type: number
         status:
-          $ref: '#/components/schemas/SyntheticsStatus'
+          $ref: '#/components/schemas/SyntheticsBatchStatus'
         test_name:
           description: Name of the test.
           type: string
@@ -14452,6 +14452,17 @@ components:
         test_type:
           $ref: '#/components/schemas/SyntheticsTestDetailsType'
       type: object
+    SyntheticsBatchStatus:
+      description: Determines whether the batch has passed, failed, or is in progress.
+      enum:
+      - passed
+      - skipped
+      - failed
+      type: string
+      x-enum-varnames:
+      - PASSED
+      - SKIPPED
+      - FAILED
     SyntheticsBrowserError:
       description: Error response object for a browser test.
       properties:
@@ -16210,18 +16221,6 @@ components:
           description: Subject Alternative Name associated with the certificate.
           type: string
       type: object
-    SyntheticsStatus:
-      description: Determines whether or not the batch has passed, failed, or is in
-        progress.
-      enum:
-      - passed
-      - skipped
-      - failed
-      type: string
-      x-enum-varnames:
-      - PASSED
-      - skipped
-      - failed
     SyntheticsStep:
       description: The steps used in a Synthetic browser test.
       properties:

docs/datadog_api_client.v1.model.rst

@@ -4141,6 +4141,13 @@ datadog\_api\_client.v1.model.synthetics\_batch\_result module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.synthetics\_batch\_status module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_batch_status
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.synthetics\_browser\_error module
 ---------------------------------------------------------------
 
@@ -4729,13 +4736,6 @@ datadog\_api\_client.v1.model.synthetics\_ssl\_certificate\_subject module
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v1.model.synthetics\_status module
--------------------------------------------------------
-
-.. automodule:: datadog_api_client.v1.model.synthetics_status
-   :members:
-   :show-inheritance:
-
 datadog\_api\_client.v1.model.synthetics\_step module
 -----------------------------------------------------
 

src/datadog_api_client/v1/model/synthetics_batch_details_data.py

@@ -16,20 +16,20 @@
 if TYPE_CHECKING:
     from datadog_api_client.v1.model.synthetics_ci_batch_metadata import SyntheticsCIBatchMetadata
     from datadog_api_client.v1.model.synthetics_batch_result import SyntheticsBatchResult
-    from datadog_api_client.v1.model.synthetics_status import SyntheticsStatus
+    from datadog_api_client.v1.model.synthetics_batch_status import SyntheticsBatchStatus
 
 
 class SyntheticsBatchDetailsData(ModelNormal):
     @cached_property
     def openapi_types(_):
         from datadog_api_client.v1.model.synthetics_ci_batch_metadata import SyntheticsCIBatchMetadata
         from datadog_api_client.v1.model.synthetics_batch_result import SyntheticsBatchResult
-        from datadog_api_client.v1.model.synthetics_status import SyntheticsStatus
+        from datadog_api_client.v1.model.synthetics_batch_status import SyntheticsBatchStatus
 
         return {
             "metadata": (SyntheticsCIBatchMetadata,),
             "results": ([SyntheticsBatchResult],),
-            "status": (SyntheticsStatus,),
+            "status": (SyntheticsBatchStatus,),
         }
 
     attribute_map = {
@@ -42,7 +42,7 @@ def __init__(
         self_,
         metadata: Union[SyntheticsCIBatchMetadata, UnsetType] = unset,
         results: Union[List[SyntheticsBatchResult], UnsetType] = unset,
-        status: Union[SyntheticsStatus, UnsetType] = unset,
+        status: Union[SyntheticsBatchStatus, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -54,8 +54,8 @@ def __init__(
         :param results: List of results for the batch.
         :type results: [SyntheticsBatchResult], optional
 
-        :param status: Determines whether or not the batch has passed, failed, or is in progress.
-        :type status: SyntheticsStatus, optional
+        :param status: Determines whether the batch has passed, failed, or is in progress.
+        :type status: SyntheticsBatchStatus, optional
         """
         if metadata is not unset:
             kwargs["metadata"] = metadata

src/datadog_api_client/v1/model/synthetics_batch_result.py

@@ -16,7 +16,7 @@
 if TYPE_CHECKING:
     from datadog_api_client.v1.model.synthetics_device_id import SyntheticsDeviceID
     from datadog_api_client.v1.model.synthetics_test_execution_rule import SyntheticsTestExecutionRule
-    from datadog_api_client.v1.model.synthetics_status import SyntheticsStatus
+    from datadog_api_client.v1.model.synthetics_batch_status import SyntheticsBatchStatus
     from datadog_api_client.v1.model.synthetics_test_details_type import SyntheticsTestDetailsType
 
 
@@ -25,7 +25,7 @@ class SyntheticsBatchResult(ModelNormal):
     def openapi_types(_):
         from datadog_api_client.v1.model.synthetics_device_id import SyntheticsDeviceID
         from datadog_api_client.v1.model.synthetics_test_execution_rule import SyntheticsTestExecutionRule
-        from datadog_api_client.v1.model.synthetics_status import SyntheticsStatus
+        from datadog_api_client.v1.model.synthetics_batch_status import SyntheticsBatchStatus
         from datadog_api_client.v1.model.synthetics_test_details_type import SyntheticsTestDetailsType
 
         return {
@@ -35,7 +35,7 @@ def openapi_types(_):
             "location": (str,),
             "result_id": (str,),
             "retries": (float,),
-            "status": (SyntheticsStatus,),
+            "status": (SyntheticsBatchStatus,),
             "test_name": (str,),
             "test_public_id": (str,),
             "test_type": (SyntheticsTestDetailsType,),
@@ -62,7 +62,7 @@ def __init__(
         location: Union[str, UnsetType] = unset,
         result_id: Union[str, UnsetType] = unset,
         retries: Union[float, UnsetType] = unset,
-        status: Union[SyntheticsStatus, UnsetType] = unset,
+        status: Union[SyntheticsBatchStatus, UnsetType] = unset,
         test_name: Union[str, UnsetType] = unset,
         test_public_id: Union[str, UnsetType] = unset,
         test_type: Union[SyntheticsTestDetailsType, UnsetType] = unset,
@@ -89,8 +89,8 @@ def __init__(
         :param retries: Number of times this result has been retried.
         :type retries: float, optional
 
-        :param status: Determines whether or not the batch has passed, failed, or is in progress.
-        :type status: SyntheticsStatus, optional
+        :param status: Determines whether the batch has passed, failed, or is in progress.
+        :type status: SyntheticsBatchStatus, optional
 
         :param test_name: Name of the test.
         :type test_name: str, optional

src/datadog_api_client/v1/model/synthetics_status.py renamed to src/datadog_api_client/v1/model/synthetics_batch_status.py

@@ -12,9 +12,9 @@
 from typing import ClassVar
 
 
-class SyntheticsStatus(ModelSimple):
+class SyntheticsBatchStatus(ModelSimple):
     """
-    Determines whether or not the batch has passed, failed, or is in progress.
+    Determines whether the batch has passed, failed, or is in progress.
 
     :param value: Must be one of ["passed", "skipped", "failed"].
     :type value: str
@@ -25,9 +25,9 @@ class SyntheticsStatus(ModelSimple):
         "skipped",
         "failed",
     }
-    PASSED: ClassVar["SyntheticsStatus"]
-    skipped: ClassVar["SyntheticsStatus"]
-    failed: ClassVar["SyntheticsStatus"]
+    PASSED: ClassVar["SyntheticsBatchStatus"]
+    SKIPPED: ClassVar["SyntheticsBatchStatus"]
+    FAILED: ClassVar["SyntheticsBatchStatus"]
 
     @cached_property
     def openapi_types(_):
@@ -36,6 +36,6 @@ def openapi_types(_):
         }
 
 
-SyntheticsStatus.PASSED = SyntheticsStatus("passed")
-SyntheticsStatus.skipped = SyntheticsStatus("skipped")
-SyntheticsStatus.failed = SyntheticsStatus("failed")
+SyntheticsBatchStatus.PASSED = SyntheticsBatchStatus("passed")
+SyntheticsBatchStatus.SKIPPED = SyntheticsBatchStatus("skipped")
+SyntheticsBatchStatus.FAILED = SyntheticsBatchStatus("failed")

src/datadog_api_client/v1/models/__init__.py

@@ -669,6 +669,7 @@
 from datadog_api_client.v1.model.synthetics_batch_details import SyntheticsBatchDetails
 from datadog_api_client.v1.model.synthetics_batch_details_data import SyntheticsBatchDetailsData
 from datadog_api_client.v1.model.synthetics_batch_result import SyntheticsBatchResult
+from datadog_api_client.v1.model.synthetics_batch_status import SyntheticsBatchStatus
 from datadog_api_client.v1.model.synthetics_browser_error import SyntheticsBrowserError
 from datadog_api_client.v1.model.synthetics_browser_error_type import SyntheticsBrowserErrorType
 from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
@@ -793,7 +794,6 @@
 from datadog_api_client.v1.model.synthetics_ssl_certificate import SyntheticsSSLCertificate
 from datadog_api_client.v1.model.synthetics_ssl_certificate_issuer import SyntheticsSSLCertificateIssuer
 from datadog_api_client.v1.model.synthetics_ssl_certificate_subject import SyntheticsSSLCertificateSubject
-from datadog_api_client.v1.model.synthetics_status import SyntheticsStatus
 from datadog_api_client.v1.model.synthetics_step import SyntheticsStep
 from datadog_api_client.v1.model.synthetics_step_detail import SyntheticsStepDetail
 from datadog_api_client.v1.model.synthetics_step_detail_warning import SyntheticsStepDetailWarning
@@ -1647,6 +1647,7 @@
     "SyntheticsBatchDetails",
     "SyntheticsBatchDetailsData",
     "SyntheticsBatchResult",
+    "SyntheticsBatchStatus",
     "SyntheticsBrowserError",
     "SyntheticsBrowserErrorType",
     "SyntheticsBrowserTest",
@@ -1731,7 +1732,6 @@
     "SyntheticsSSLCertificate",
     "SyntheticsSSLCertificateIssuer",
     "SyntheticsSSLCertificateSubject",
-    "SyntheticsStatus",
     "SyntheticsStep",
     "SyntheticsStepDetail",
     "SyntheticsStepDetailWarning",