Regenerate client from commit f614243 of spec repo (#308)

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.4.1.dev8",
-            "regenerated": "2021-03-05 09:33:11.594025",
-            "spec_repo_commit": "aad6dbb"
+            "regenerated": "2021-03-05 15:51:21.070609",
+            "spec_repo_commit": "f614243"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev8",
-            "regenerated": "2021-03-05 09:33:46.163813",
-            "spec_repo_commit": "aad6dbb"
+            "regenerated": "2021-03-05 15:52:06.307614",
+            "spec_repo_commit": "f614243"
         }
     }
 }

docs/v1/README.md

@@ -598,6 +598,7 @@ Class | Method | HTTP request | Description
  - [SyntheticsCheckType](SyntheticsCheckType.md)
  - [SyntheticsConfigVariable](SyntheticsConfigVariable.md)
  - [SyntheticsConfigVariableType](SyntheticsConfigVariableType.md)
+ - [SyntheticsCoreWebVitals](SyntheticsCoreWebVitals.md)
  - [SyntheticsDeleteTestsPayload](SyntheticsDeleteTestsPayload.md)
  - [SyntheticsDeleteTestsResponse](SyntheticsDeleteTestsResponse.md)
  - [SyntheticsDeletedTest](SyntheticsDeletedTest.md)

docs/v1/SyntheticsCoreWebVitals.md

@@ -0,0 +1,13 @@
+# SyntheticsCoreWebVitals
+
+Core Web Vitals attached to a browser test step.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cls** | **int** | Cumulative Layout Shift. | [optional] 
+**lcp** | **int** | Largest Contentful Paint in milliseconds. | [optional] 
+**url** | **str** | URL attached to the metrics. | [optional] 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/SyntheticsStepDetail.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **type** | [**SyntheticsStepType**](SyntheticsStepType.md) |  | [optional] 
 **url** | **str** | URL to perform the step against. | [optional] 
 **value** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Value for the step. | [optional] 
+**vitals_metrics** | [**[SyntheticsCoreWebVitals]**](SyntheticsCoreWebVitals.md) | Array of Core Web Vitals metrics for the step. | [optional] 
 **warnings** | [**[SyntheticsStepDetailWarning]**](SyntheticsStepDetailWarning.md) | Warning collected that didn't failed the step. | [optional] 
 
 [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

src/datadog_api_client/v1/model/synthetics_core_web_vitals.py

@@ -0,0 +1,171 @@
+# 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.
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+import nulltype  # noqa: F401
+
+from datadog_api_client.v1.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+)
+
+
+class SyntheticsCoreWebVitals(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {}
+
+    validations = {}
+
+    additional_properties_type = None
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        return {
+            "cls": (int,),  # noqa: E501
+            "lcp": (int,),  # noqa: E501
+            "url": (str,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+    attribute_map = {
+        "cls": "cls",  # noqa: E501
+        "lcp": "lcp",  # noqa: E501
+        "url": "url",  # noqa: E501
+    }
+
+    _composed_schemas = {}
+
+    required_properties = set(
+        [
+            "_data_store",
+            "_check_type",
+            "_spec_property_naming",
+            "_path_to_item",
+            "_configuration",
+            "_visited_composed_classes",
+        ]
+    )
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """SyntheticsCoreWebVitals - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            cls (int): Cumulative Layout Shift.. [optional]  # noqa: E501
+            lcp (int): Largest Contentful Paint in milliseconds.. [optional]  # noqa: E501
+            url (str): URL attached to the metrics.. [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop("_check_type", True)
+        _spec_property_naming = kwargs.pop("_spec_property_naming", False)
+        _path_to_item = kwargs.pop("_path_to_item", ())
+        _configuration = kwargs.pop("_configuration", None)
+        _visited_composed_classes = kwargs.pop("_visited_composed_classes", ())
+
+        if args:
+            raise ApiTypeError(
+                "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments."
+                % (
+                    args,
+                    self.__class__.__name__,
+                ),
+                path_to_item=_path_to_item,
+                valid_classes=(self.__class__,),
+            )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if (
+                var_name not in self.attribute_map
+                and self._configuration is not None
+                and self._configuration.discard_unknown_keys
+                and self.additional_properties_type is None
+            ):
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)

src/datadog_api_client/v1/model/synthetics_step_detail.py

@@ -27,12 +27,14 @@
 def lazy_import():
     from datadog_api_client.v1.model.synthetics_browser_error import SyntheticsBrowserError
     from datadog_api_client.v1.model.synthetics_check_type import SyntheticsCheckType
+    from datadog_api_client.v1.model.synthetics_core_web_vitals import SyntheticsCoreWebVitals
     from datadog_api_client.v1.model.synthetics_playing_tab import SyntheticsPlayingTab
     from datadog_api_client.v1.model.synthetics_step_detail_warning import SyntheticsStepDetailWarning
     from datadog_api_client.v1.model.synthetics_step_type import SyntheticsStepType
 
     globals()["SyntheticsBrowserError"] = SyntheticsBrowserError
     globals()["SyntheticsCheckType"] = SyntheticsCheckType
+    globals()["SyntheticsCoreWebVitals"] = SyntheticsCoreWebVitals
     globals()["SyntheticsPlayingTab"] = SyntheticsPlayingTab
     globals()["SyntheticsStepDetailWarning"] = SyntheticsStepDetailWarning
     globals()["SyntheticsStepType"] = SyntheticsStepType
@@ -97,6 +99,7 @@ def openapi_types():
             "type": (SyntheticsStepType,),  # noqa: E501
             "url": (str,),  # noqa: E501
             "value": ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),  # noqa: E501
+            "vitals_metrics": ([SyntheticsCoreWebVitals],),  # noqa: E501
             "warnings": ([SyntheticsStepDetailWarning],),  # noqa: E501
         }
 
@@ -120,6 +123,7 @@ def discriminator():
         "type": "type",  # noqa: E501
         "url": "url",  # noqa: E501
         "value": "value",  # noqa: E501
+        "vitals_metrics": "vitalsMetrics",  # noqa: E501
         "warnings": "warnings",  # noqa: E501
     }
 
@@ -186,6 +190,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             type (SyntheticsStepType): [optional]  # noqa: E501
             url (str): URL to perform the step against.. [optional]  # noqa: E501
             value ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Value for the step.. [optional]  # noqa: E501
+            vitals_metrics ([SyntheticsCoreWebVitals]): Array of Core Web Vitals metrics for the step.. [optional]  # noqa: E501
             warnings ([SyntheticsStepDetailWarning]): Warning collected that didn't failed the step.. [optional]  # noqa: E501
         """
 

src/datadog_api_client/v1/models/__init__.py

@@ -345,6 +345,7 @@
 from datadog_api_client.v1.model.synthetics_check_type import SyntheticsCheckType
 from datadog_api_client.v1.model.synthetics_config_variable import SyntheticsConfigVariable
 from datadog_api_client.v1.model.synthetics_config_variable_type import SyntheticsConfigVariableType
+from datadog_api_client.v1.model.synthetics_core_web_vitals import SyntheticsCoreWebVitals
 from datadog_api_client.v1.model.synthetics_delete_tests_payload import SyntheticsDeleteTestsPayload
 from datadog_api_client.v1.model.synthetics_delete_tests_response import SyntheticsDeleteTestsResponse
 from datadog_api_client.v1.model.synthetics_deleted_test import SyntheticsDeletedTest

src/datadog_api_client/v1/openapi.yaml

@@ -6975,6 +6975,21 @@ components:
       type: string
       x-enum-varnames:
       - TEXT
+    SyntheticsCoreWebVitals:
+      description: Core Web Vitals attached to a browser test step.
+      properties:
+        cls:
+          description: Cumulative Layout Shift.
+          format: int64
+          type: integer
+        lcp:
+          description: Largest Contentful Paint in milliseconds.
+          format: int64
+          type: integer
+        url:
+          description: URL attached to the metrics.
+          type: string
+      type: object
     SyntheticsDeleteTestsPayload:
       description: 'A JSON list of the ID or IDs of the Synthetic tests that you want
 
@@ -7497,6 +7512,11 @@ components:
         value:
           description: Value for the step.
           type: object
+        vitalsMetrics:
+          description: Array of Core Web Vitals metrics for the step.
+          items:
+            $ref: '#/components/schemas/SyntheticsCoreWebVitals'
+          type: array
         warnings:
           description: Warning collected that didn't failed the step.
           items:

tests/v1/test_synthetics_core_web_vitals.py

@@ -0,0 +1,30 @@
+# 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.
+
+
+import sys
+import unittest
+
+import datadog_api_client.v1
+from datadog_api_client.v1.model.synthetics_core_web_vitals import SyntheticsCoreWebVitals
+
+
+class TestSyntheticsCoreWebVitals(unittest.TestCase):
+    """SyntheticsCoreWebVitals unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testSyntheticsCoreWebVitals(self):
+        """Test SyntheticsCoreWebVitals"""
+        # FIXME: construct object with mandatory attributes with example values
+        # model = SyntheticsCoreWebVitals()  # noqa: E501
+        pass
+
+
+if __name__ == "__main__":
+    unittest.main()