Regenerate client from commit 4796132 of spec repo (#191)

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.0",
-            "regenerated": "2020-12-15 12:13:29.100642",
-            "spec_repo_commit": "690ad2a"
+            "regenerated": "2020-12-16 12:20:23.743894",
+            "spec_repo_commit": "4796132"
         },
         "v2": {
             "apigentools_version": "1.4.0",
-            "regenerated": "2020-12-15 12:13:39.491922",
-            "spec_repo_commit": "690ad2a"
+            "regenerated": "2020-12-16 12:20:34.655262",
+            "spec_repo_commit": "4796132"
         }
     }
 }

docs/README.md

@@ -1,11 +1,112 @@
 # datadog-api-client-python
 
-Collection of all of the Datadog public endpoints. For the official documentation, see the [Datadog API Reference](https://docs.datadoghq.com/api/).
+This repository contains a Python API client for the [Datadog API](https://docs.datadoghq.com/api/).
+The code is generated using [openapi-generator](https://github.com/OpenAPITools/openapi-generator)
+and [apigentools](https://github.com/DataDog/apigentools).
 
-This python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
+Datadog API Collection
 
-Need help? Reach out to our awesome [support team](https://www.datadoghq.com/support/).
+- API version: 1.0
+
+Collection of all Datadog Public endpoints.
+
+  For more information, please visit [https://www.datadoghq.com/support/](https://www.datadoghq.com/support/)
+
+*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
+
+## Requirements
+
+Building and using the API client library requires:
+
+1. Python 3.6+
+
+## Installation
+
+To install the API client library, simply execute:
+
+```shell
+pip install datadog-api-client
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) instruction and execute the following Python code:
+
+```python
+import os
+from dateutil.parser import parse as dateutil_parser
+import datadog_api_client.v1
+from datadog_api_client.v1.api import aws_integration_api
+from datadog_api_client.v1.models import *
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.datadoghq.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = datadog_api_client.v1.Configuration(
+    host = "https://api.datadoghq.com"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: apiKeyAuth
+configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY')
+
+# Configure API key authorization: appKeyAuth
+configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY')
+
+# Enter a context with an instance of the API client
+with datadog_api_client.v1.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = aws_integration_api.AWSIntegrationApi(api_client)
+    body = AWSAccount(
+        access_key_id="access_key_id_example",
+        account_id="1234567",
+        account_specific_namespace_rules={
+            "key": True,
+        },
+        excluded_regions=["us-east-1","us-west-2"],
+        filter_tags=["<KEY>:<VALUE>"],
+        host_tags=["<KEY>:<VALUE>"],
+        role_name="DatadogAWSIntegrationRole",
+        secret_access_key="secret_access_key_example",
+    ) # AWSAccount | AWS Request Object
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Create an AWS integration
+        api_response = api_instance.create_aws_account(body)
+        pprint(api_response)
+    except datadog_api_client.v1.ApiException as e:
+        print("Exception when calling AWSIntegrationApi->create_aws_account: %s\n" % e)
+```
+
+### Unstable Endpoints
+
+This client includes access to Datadog API endpoints while they are in an unstable state and may undergo breaking changes. An extra configuration step is required to enable these endpoints:
+
+```python
+configuration.unstable_operations["<OperationName>"] = True
+```
+
+where `<OperationName>` is the name of the method used to interact with that endpoint. For example: `list_log_indexes`, or `get_logs_index`
+
+## Documentation for API Endpoints and Models
+
+Documentation for API endpoints and models can be found under the [`docs`](/docs) directory. 
+
+## Documentation for Authorization
+
+Authenticate with the API by providing your API and Application keys in the configuration:
+
+```python
+configuration.api_key["apiKeyAuth"] = "YOUR_API_KEY"
+configuration.api_key["appKeyAuth"] = "YOUR_APPLICATION_KEY"
+```
 
 ## Author
 
 [email protected]
+

src/datadog_api_client/v1/api/aws_integration_api.py

@@ -173,7 +173,7 @@ def __create_aws_tag_filter(
             >>> result = thread.get()
 
             Args:
-                body (AWSTagFilterCreateRequest): Set an AWS tag filter using an `aws_account_identifier`, `namespace`, and filtering string. Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs`, and `custom`.
+                body (AWSTagFilterCreateRequest): Set an AWS tag filter using an `aws_account_identifier`, `namespace`, and filtering string. Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs`, and `custom`.
 
             Keyword Args:
                 _return_http_data_only (bool): response data without head status
@@ -568,7 +568,7 @@ def __delete_aws_tag_filter(
             >>> result = thread.get()
 
             Args:
-                body (AWSTagFilterDeleteRequest): Delete a tag filtering entry for a given AWS account and `dd-aws` namespace.
+                body (AWSTagFilterDeleteRequest): Delete a tag filtering entry for a given AWS account and `dd-aws` namespace.
 
             Keyword Args:
                 _return_http_data_only (bool): response data without head status
@@ -955,7 +955,7 @@ def __list_aws_tag_filters(
             >>> result = thread.get()
 
             Args:
-                account_id (str): Only return AWS filters that matches this `account_id`.
+                account_id (str): Only return AWS filters that matches this `account_id`.
 
             Keyword Args:
                 _return_http_data_only (bool): response data without head status

src/datadog_api_client/v1/api/azure_integration_api.py

@@ -398,7 +398,7 @@ def __update_azure_host_filters(
             >>> result = thread.get()
 
             Args:
-                body (AzureAccount): Update a Datadog-Azure integration's host filters request body.
+                body (AzureAccount): Update a Datadog-Azure integration's host filters request body.
 
             Keyword Args:
                 _return_http_data_only (bool): response data without head status

src/datadog_api_client/v1/api/logs_indexes_api.py

@@ -389,7 +389,7 @@ def __update_logs_index(
 
             Args:
                 name (str): Name of the log index.
-                body (LogsIndexUpdateRequest): Object containing the new `LogsIndexUpdateRequest`.
+                body (LogsIndexUpdateRequest): Object containing the new `LogsIndexUpdateRequest`.
 
             Keyword Args:
                 _return_http_data_only (bool): response data without head status

src/datadog_api_client/v1/api/metrics_api.py

@@ -296,7 +296,7 @@ def __list_metrics(
             >>> result = thread.get()
 
             Args:
-                q (str): Query string to search metrics upon. Must be prefixed with `metrics:`.
+                q (str): Query string to search metrics upon. Must be prefixed with `metrics:`.
 
             Keyword Args:
                 _return_http_data_only (bool): response data without head status

src/datadog_api_client/v1/api/organizations_api.py

@@ -173,7 +173,7 @@ def __get_org(
             >>> result = thread.get()
 
             Args:
-                public_id (str): The `public_id` of the organization you are operating within.
+                public_id (str): The `public_id` of the organization you are operating within.
 
             Keyword Args:
                 _return_http_data_only (bool): response data without head status
@@ -402,7 +402,7 @@ def __update_org(
             >>> result = thread.get()
 
             Args:
-                public_id (str): The `public_id` of the organization you are operating within.
+                public_id (str): The `public_id` of the organization you are operating within.
                 body (Organization):
 
             Keyword Args:
@@ -533,7 +533,7 @@ def __upload_id_p_for_org(
             >>> result = thread.get()
 
             Args:
-                public_id (str): The `public_id` of the organization you are operating with
+                public_id (str): The `public_id` of the organization you are operating with
                 idp_file (file_type): The path to the XML metadata file you wish to upload.
 
             Keyword Args:

src/datadog_api_client/v1/api/service_level_objectives_api.py

@@ -666,8 +666,8 @@ def __get_slo_history(
 
             Args:
                 slo_id (str): The ID of the service level objective object.
-                from_ts (int): The `from` timestamp for the query window in epoch seconds.
-                to_ts (int): The `to` timestamp for the query window in epoch seconds.
+                from_ts (int): The `from` timestamp for the query window in epoch seconds.
+                to_ts (int): The `to` timestamp for the query window in epoch seconds.
 
             Keyword Args:
                 _return_http_data_only (bool): response data without head status

src/datadog_api_client/v1/api/usage_metering_api.py

@@ -207,7 +207,7 @@ def __get_incident_management(
             >>> result = thread.get()
 
             Args:
-                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
 
             Keyword Args:
                 end_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.. [optional]
@@ -333,7 +333,7 @@ def __get_ingested_spans(
             >>> result = thread.get()
 
             Args:
-                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
 
             Keyword Args:
                 end_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.. [optional]
@@ -831,7 +831,7 @@ def __get_tracing_without_limits(
             >>> result = thread.get()
 
             Args:
-                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
 
             Keyword Args:
                 end_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.. [optional]
@@ -957,7 +957,7 @@ def __get_usage_analyzed_logs(
             >>> result = thread.get()
 
             Args:
-                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
 
             Keyword Args:
                 end_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.. [optional]
@@ -1084,7 +1084,7 @@ def __get_usage_attribution(
             >>> result = thread.get()
 
             Args:
-                start_month (datetime): Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago.
+                start_month (datetime): Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago.
                 fields (str): The specified field to search results for.
 
             Keyword Args:
@@ -1597,7 +1597,7 @@ def __get_usage_indexed_spans(
             >>> result = thread.get()
 
             Args:
-                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
 
             Keyword Args:
                 end_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.. [optional]
@@ -2108,7 +2108,7 @@ def __get_usage_network_flows(
             >>> result = thread.get()
 
             Args:
-                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
 
             Keyword Args:
                 end_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.. [optional]
@@ -2360,7 +2360,7 @@ def __get_usage_profiling(
             >>> result = thread.get()
 
             Args:
-                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
 
             Keyword Args:
                 end_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.. [optional]
@@ -2618,7 +2618,7 @@ def __get_usage_snmp(
             >>> result = thread.get()
 
             Args:
-                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
+                start_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
 
             Keyword Args:
                 end_hr (datetime): Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.. [optional]
@@ -2744,7 +2744,7 @@ def __get_usage_summary(
             >>> result = thread.get()
 
             Args:
-                start_month (datetime): Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago.
+                start_month (datetime): Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago.
 
             Keyword Args:
                 end_month (datetime): Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month.. [optional]

src/datadog_api_client/v1/configuration.py

@@ -68,6 +68,8 @@ class Configuration(object):
     :param server_operation_variables: Mapping from operation ID to a mapping with
       string values to replace variables in templated server configuration.
       The validation of enums is performed for variables with defined enum values before.
+    :param ssl_ca_cert: str - the path to a file of concatenated CA certificates 
+      in PEM format
 
     :Example:
 
@@ -100,6 +102,7 @@ def __init__(self, host=None,
                  disabled_client_side_validations="",
                  server_index=None, server_variables=None,
                  server_operation_index=None, server_operation_variables=None,
+                 ssl_ca_cert=None,
                  ):
         """Constructor
         """
@@ -165,7 +168,7 @@ def __init__(self, host=None,
            Set this to false to skip verifying SSL certificate when calling API
            from https server.
         """
-        self.ssl_ca_cert = None
+        self.ssl_ca_cert = ssl_ca_cert
         """Set this to customize the certificate file to verify the peer.
         """
         self.cert_file = None