Make value be oneOf number or string (#2229)

* Regenerate client from commit e9cc5e6a 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-10-31 14:20:03.543613",
-            "spec_repo_commit": "47da2e01"
+            "regenerated": "2024-10-31 14:51:16.444741",
+            "spec_repo_commit": "e9cc5e6a"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-31 14:20:03.561286",
-            "spec_repo_commit": "47da2e01"
+            "regenerated": "2024-10-31 14:51:16.462544",
+            "spec_repo_commit": "e9cc5e6a"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -15530,7 +15530,7 @@ components:
           $ref: '#/components/schemas/SyntheticsMobileStepParamsDirection'
         element:
           $ref: '#/components/schemas/SyntheticsMobileStepParamsElement'
-        enable:
+        enabled:
           description: Boolean to change the state of the wifi for a `toggleWiFi`
             step type.
           type: boolean
@@ -15546,8 +15546,7 @@ components:
             step type.
           type: string
         value:
-          description: Values used in the step. Used in multiple step types.
-          type: string
+          $ref: '#/components/schemas/SyntheticsMobileStepParamsValue'
         variable:
           $ref: '#/components/schemas/SyntheticsMobileStepParamsVariable'
         withEnter:
@@ -15556,12 +15555,12 @@ components:
           type: boolean
         x:
           description: Amount to scroll by on the `x` axis for a `scroll` step type.
-          format: int64
-          type: integer
+          format: double
+          type: number
         y:
           description: Amount to scroll by on the `y` axis for a `scroll` step type.
-          format: int64
-          type: integer
+          format: double
+          type: number
       type: object
     SyntheticsMobileStepParamsDirection:
       description: The direction of the scroll for a `scrollToElement` step type.
@@ -15615,12 +15614,12 @@ components:
       properties:
         x:
           description: The `relativePosition` on the `x` axis for the element.
-          format: int64
-          type: integer
+          format: double
+          type: number
         y:
           description: The `relativePosition` on the `y` axis for the element.
-          format: int64
-          type: integer
+          format: double
+          type: number
       type: object
     SyntheticsMobileStepParamsElementUserLocator:
       description: User locator to find the element.
@@ -15670,13 +15669,25 @@ components:
       properties:
         x:
           description: The `x` position for the flick.
-          format: int64
-          type: integer
+          format: double
+          type: number
         y:
           description: The `y` position for the flick.
-          format: int64
-          type: integer
+          format: double
+          type: number
       type: object
+    SyntheticsMobileStepParamsValue:
+      description: Values used in the step for in multiple step types.
+      oneOf:
+      - $ref: '#/components/schemas/SyntheticsMobileStepParamsValueString'
+      - $ref: '#/components/schemas/SyntheticsMobileStepParamsValueNumber'
+    SyntheticsMobileStepParamsValueNumber:
+      description: Value used in the step for in multiple step types.
+      format: int64
+      type: integer
+    SyntheticsMobileStepParamsValueString:
+      description: Value used in the step for in multiple step types.
+      type: string
     SyntheticsMobileStepParamsVariable:
       description: Variable object for `extractVariable` step type.
       properties:

docs/datadog_api_client.v1.model.rst

@@ -4547,6 +4547,13 @@ datadog\_api\_client.v1.model.synthetics\_mobile\_step\_params\_positions\_items
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.synthetics\_mobile\_step\_params\_value module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_mobile_step_params_value
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.synthetics\_mobile\_step\_params\_variable module
 -------------------------------------------------------------------------------
 

src/datadog_api_client/v1/model/synthetics_mobile_step_params.py

@@ -20,6 +20,7 @@
     from datadog_api_client.v1.model.synthetics_mobile_step_params_positions_items import (
         SyntheticsMobileStepParamsPositionsItems,
     )
+    from datadog_api_client.v1.model.synthetics_mobile_step_params_value import SyntheticsMobileStepParamsValue
     from datadog_api_client.v1.model.synthetics_mobile_step_params_variable import SyntheticsMobileStepParamsVariable
 
 
@@ -41,6 +42,7 @@ def openapi_types(_):
         from datadog_api_client.v1.model.synthetics_mobile_step_params_positions_items import (
             SyntheticsMobileStepParamsPositionsItems,
         )
+        from datadog_api_client.v1.model.synthetics_mobile_step_params_value import SyntheticsMobileStepParamsValue
         from datadog_api_client.v1.model.synthetics_mobile_step_params_variable import (
             SyntheticsMobileStepParamsVariable,
         )
@@ -50,23 +52,23 @@ def openapi_types(_):
             "delay": (int,),
             "direction": (SyntheticsMobileStepParamsDirection,),
             "element": (SyntheticsMobileStepParamsElement,),
-            "enable": (bool,),
+            "enabled": (bool,),
             "max_scrolls": (int,),
             "positions": ([SyntheticsMobileStepParamsPositionsItems],),
             "subtest_public_id": (str,),
-            "value": (str,),
+            "value": (SyntheticsMobileStepParamsValue,),
             "variable": (SyntheticsMobileStepParamsVariable,),
             "with_enter": (bool,),
-            "x": (int,),
-            "y": (int,),
+            "x": (float,),
+            "y": (float,),
         }
 
     attribute_map = {
         "check": "check",
         "delay": "delay",
         "direction": "direction",
         "element": "element",
-        "enable": "enable",
+        "enabled": "enabled",
         "max_scrolls": "maxScrolls",
         "positions": "positions",
         "subtest_public_id": "subtestPublicId",
@@ -83,15 +85,15 @@ def __init__(
         delay: Union[int, UnsetType] = unset,
         direction: Union[SyntheticsMobileStepParamsDirection, UnsetType] = unset,
         element: Union[SyntheticsMobileStepParamsElement, UnsetType] = unset,
-        enable: Union[bool, UnsetType] = unset,
+        enabled: Union[bool, UnsetType] = unset,
         max_scrolls: Union[int, UnsetType] = unset,
         positions: Union[List[SyntheticsMobileStepParamsPositionsItems], UnsetType] = unset,
         subtest_public_id: Union[str, UnsetType] = unset,
-        value: Union[str, UnsetType] = unset,
+        value: Union[SyntheticsMobileStepParamsValue, str, int, UnsetType] = unset,
         variable: Union[SyntheticsMobileStepParamsVariable, UnsetType] = unset,
         with_enter: Union[bool, UnsetType] = unset,
-        x: Union[int, UnsetType] = unset,
-        y: Union[int, UnsetType] = unset,
+        x: Union[float, UnsetType] = unset,
+        y: Union[float, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -109,8 +111,8 @@ def __init__(
         :param element: Information about the element used for a step.
         :type element: SyntheticsMobileStepParamsElement, optional
 
-        :param enable: Boolean to change the state of the wifi for a ``toggleWiFi`` step type.
-        :type enable: bool, optional
+        :param enabled: Boolean to change the state of the wifi for a ``toggleWiFi`` step type.
+        :type enabled: bool, optional
 
         :param max_scrolls: Maximum number of scrolls to do for a ``scrollToElement`` step type.
         :type max_scrolls: int, optional
@@ -121,8 +123,8 @@ def __init__(
         :param subtest_public_id: Public ID of the test to be played as part of a ``playSubTest`` step type.
         :type subtest_public_id: str, optional
 
-        :param value: Values used in the step. Used in multiple step types.
-        :type value: str, optional
+        :param value: Values used in the step for in multiple step types.
+        :type value: SyntheticsMobileStepParamsValue, optional
 
         :param variable: Variable object for ``extractVariable`` step type.
         :type variable: SyntheticsMobileStepParamsVariable, optional
@@ -131,10 +133,10 @@ def __init__(
         :type with_enter: bool, optional
 
         :param x: Amount to scroll by on the ``x`` axis for a ``scroll`` step type.
-        :type x: int, optional
+        :type x: float, optional
 
         :param y: Amount to scroll by on the ``y`` axis for a ``scroll`` step type.
-        :type y: int, optional
+        :type y: float, optional
         """
         if check is not unset:
             kwargs["check"] = check
@@ -144,8 +146,8 @@ def __init__(
             kwargs["direction"] = direction
         if element is not unset:
             kwargs["element"] = element
-        if enable is not unset:
-            kwargs["enable"] = enable
+        if enabled is not unset:
+            kwargs["enabled"] = enabled
         if max_scrolls is not unset:
             kwargs["max_scrolls"] = max_scrolls
         if positions is not unset:

src/datadog_api_client/v1/model/synthetics_mobile_step_params_element_relative_position.py

@@ -17,24 +17,24 @@ class SyntheticsMobileStepParamsElementRelativePosition(ModelNormal):
     @cached_property
     def openapi_types(_):
         return {
-            "x": (int,),
-            "y": (int,),
+            "x": (float,),
+            "y": (float,),
         }
 
     attribute_map = {
         "x": "x",
         "y": "y",
     }
 
-    def __init__(self_, x: Union[int, UnsetType] = unset, y: Union[int, UnsetType] = unset, **kwargs):
+    def __init__(self_, x: Union[float, UnsetType] = unset, y: Union[float, UnsetType] = unset, **kwargs):
         """
         Position of the action relative to the element.
 
         :param x: The ``relativePosition`` on the ``x`` axis for the element.
-        :type x: int, optional
+        :type x: float, optional
 
         :param y: The ``relativePosition`` on the ``y`` axis for the element.
-        :type y: int, optional
+        :type y: float, optional
         """
         if x is not unset:
             kwargs["x"] = x

src/datadog_api_client/v1/model/synthetics_mobile_step_params_positions_items.py

@@ -17,24 +17,24 @@ class SyntheticsMobileStepParamsPositionsItems(ModelNormal):
     @cached_property
     def openapi_types(_):
         return {
-            "x": (int,),
-            "y": (int,),
+            "x": (float,),
+            "y": (float,),
         }
 
     attribute_map = {
         "x": "x",
         "y": "y",
     }
 
-    def __init__(self_, x: Union[int, UnsetType] = unset, y: Union[int, UnsetType] = unset, **kwargs):
+    def __init__(self_, x: Union[float, UnsetType] = unset, y: Union[float, UnsetType] = unset, **kwargs):
         """
         A description of a single position for a ``flick`` step type.
 
         :param x: The ``x`` position for the flick.
-        :type x: int, optional
+        :type x: float, optional
 
         :param y: The ``y`` position for the flick.
-        :type y: int, optional
+        :type y: float, optional
         """
         if x is not unset:
             kwargs["x"] = x

src/datadog_api_client/v1/model/synthetics_mobile_step_params_value.py

@@ -0,0 +1,34 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelComposed,
+    cached_property,
+)
+
+
+class SyntheticsMobileStepParamsValue(ModelComposed):
+    def __init__(self, **kwargs):
+        """
+        Values used in the step for in multiple step types.
+        """
+        super().__init__(kwargs)
+
+    @cached_property
+    def _composed_schemas(_):
+        # we need this here to make our import statements work
+        # we must store _composed_schemas in here so the code is only run
+        # when we invoke this method. If we kept this at the class
+        # level we would get an error because the class level
+        # code would be run when this module is imported, and these composed
+        # classes don't exist yet because their module has not finished
+        # loading
+        return {
+            "oneOf": [
+                str,
+                int,
+            ],
+        }

src/datadog_api_client/v1/models/__init__.py

@@ -753,6 +753,7 @@
 from datadog_api_client.v1.model.synthetics_mobile_step_params_positions_items import (
     SyntheticsMobileStepParamsPositionsItems,
 )
+from datadog_api_client.v1.model.synthetics_mobile_step_params_value import SyntheticsMobileStepParamsValue
 from datadog_api_client.v1.model.synthetics_mobile_step_params_variable import SyntheticsMobileStepParamsVariable
 from datadog_api_client.v1.model.synthetics_mobile_step_type import SyntheticsMobileStepType
 from datadog_api_client.v1.model.synthetics_mobile_test import SyntheticsMobileTest
@@ -1704,6 +1705,7 @@
     "SyntheticsMobileStepParamsElementUserLocatorValuesItems",
     "SyntheticsMobileStepParamsElementUserLocatorValuesItemsType",
     "SyntheticsMobileStepParamsPositionsItems",
+    "SyntheticsMobileStepParamsValue",
     "SyntheticsMobileStepParamsVariable",
     "SyntheticsMobileStepType",
     "SyntheticsMobileTest",