Regenerate client from commit a046371 of spec repo (#262)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-10-14 17:40:41.250792",
-            "spec_repo_commit": "5bae09b"
+            "regenerated": "2021-10-15 13:58:22.489036",
+            "spec_repo_commit": "a046371"
         },
         "v2": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-10-14 17:41:35.387541",
-            "spec_repo_commit": "5bae09b"
+            "regenerated": "2021-10-15 13:59:18.724218",
+            "spec_repo_commit": "a046371"
         }
     }
 }

docs/v1/SyntheticsApi.md

@@ -20,6 +20,7 @@ All URIs are relative to *https://api.datadoghq.com*
 | [**getBrowserTestResult**](SyntheticsApi.md#getBrowserTestResult)               | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a browser test result                         |
 | [**getGlobalVariable**](SyntheticsApi.md#getGlobalVariable)                     | **GET** /api/v1/synthetics/variables/{variable_id}                       | Get a global variable                             |
 | [**getPrivateLocation**](SyntheticsApi.md#getPrivateLocation)                   | **GET** /api/v1/synthetics/private-locations/{location_id}               | Get a private location                            |
+| [**getSyntheticsCIBatch**](SyntheticsApi.md#getSyntheticsCIBatch)               | **GET** /api/v1/synthetics/ci/batch/{batch_id}                           | Get details of batch                              |
 | [**getTest**](SyntheticsApi.md#getTest)                                         | **GET** /api/v1/synthetics/tests/{public_id}                             | Get a test configuration                          |
 | [**listGlobalVariables**](SyntheticsApi.md#listGlobalVariables)                 | **GET** /api/v1/synthetics/variables                                     | Get all global variables                          |
 | [**listLocations**](SyntheticsApi.md#listLocations)                             | **GET** /api/v1/synthetics/locations                                     | Get all locations (public and private)            |
@@ -1277,6 +1278,64 @@ apiInstance
 
 [[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)
 
+## **getSyntheticsCIBatch**
+
+> SyntheticsBatchDetails getSyntheticsCIBatch()
+
+Get a batch's updated details.
+
+### Example
+
+```typescript
+import { v1 } from "@datadog/datadog-api-client";
+import * as fs from "fs";
+
+const configuration = v1.createConfiguration();
+const apiInstance = new v1.SyntheticsApi(configuration);
+
+let params: v1.SyntheticsApiGetSyntheticsCIBatchRequest = {
+  // string | The ID of the batch.
+  batchId: "batch_id_example",
+};
+
+apiInstance
+  .getSyntheticsCIBatch(params)
+  .then((data: any) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));
+```
+
+### Parameters
+
+| Name        | Type         | Description          | Notes                 |
+| ----------- | ------------ | -------------------- | --------------------- |
+| **batchId** | [**string**] | The ID of the batch. | defaults to undefined |
+
+### Return type
+
+**SyntheticsBatchDetails**
+
+### Authorization
+
+[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description           | Response headers |
+| ----------- | --------------------- | ---------------- |
+| **200**     | OK                    | -                |
+| **404**     | Batch does not exist. | -                |
+
+[[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)
+
 ## **getTest**
 
 > SyntheticsTestDetails getTest()

features/v1/synthetics.feature

@@ -389,6 +389,20 @@ Feature: Synthetics
     When the request is sent
     Then the response status is 200 OK
 
+  @generated @skip
+  Scenario: Get details of batch returns "Batch does not exist." response
+    Given new "GetSyntheticsCIBatch" request
+    And request contains "batch_id" parameter from "<PATH>"
+    When the request is sent
+    Then the response status is 404 Batch does not exist.
+
+  @generated @skip
+  Scenario: Get details of batch returns "OK" response
+    Given new "GetSyntheticsCIBatch" request
+    And request contains "batch_id" parameter from "<PATH>"
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip
   Scenario: Get the list of all tests returns "OK - Returns the list of all Synthetic tests." response
     Given new "ListTests" request

features/v1/undo.json

@@ -927,6 +927,12 @@
       "type": "safe"
     }
   },
+  "GetSyntheticsCIBatch": {
+    "tag": "Synthetics",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "ListLocations": {
     "tag": "Synthetics",
     "undo": {

packages/datadog-api-client-v1/.openapi-generator/FILES

@@ -465,6 +465,9 @@ models/SyntheticsAssertionOperator.ts
 models/SyntheticsAssertionTarget.ts
 models/SyntheticsAssertionType.ts
 models/SyntheticsBasicAuth.ts
+models/SyntheticsBatchDetails.ts
+models/SyntheticsBatchDetailsData.ts
+models/SyntheticsBatchResult.ts
 models/SyntheticsBrowserError.ts
 models/SyntheticsBrowserErrorType.ts
 models/SyntheticsBrowserTest.ts
@@ -477,11 +480,11 @@ models/SyntheticsBrowserTestResultShortResult.ts
 models/SyntheticsBrowserTestType.ts
 models/SyntheticsBrowserVariable.ts
 models/SyntheticsBrowserVariableType.ts
+models/SyntheticsCIBatchMetadata.ts
+models/SyntheticsCIBatchMetadataCI.ts
+models/SyntheticsCIBatchMetadataGit.ts
 models/SyntheticsCITest.ts
 models/SyntheticsCITestBody.ts
-models/SyntheticsCITestMetadata.ts
-models/SyntheticsCITestMetadataCi.ts
-models/SyntheticsCITestMetadataGit.ts
 models/SyntheticsCheckType.ts
 models/SyntheticsConfigVariable.ts
 models/SyntheticsConfigVariableType.ts
@@ -515,6 +518,7 @@ models/SyntheticsPrivateLocationSecretsConfigDecryption.ts
 models/SyntheticsSSLCertificate.ts
 models/SyntheticsSSLCertificateIssuer.ts
 models/SyntheticsSSLCertificateSubject.ts
+models/SyntheticsStatus.ts
 models/SyntheticsStep.ts
 models/SyntheticsStepDetail.ts
 models/SyntheticsStepDetailWarning.ts
@@ -523,6 +527,7 @@ models/SyntheticsTestConfig.ts
 models/SyntheticsTestDetails.ts
 models/SyntheticsTestDetailsSubType.ts
 models/SyntheticsTestDetailsType.ts
+models/SyntheticsTestExecutionRule.ts
 models/SyntheticsTestMonitorStatus.ts
 models/SyntheticsTestOptions.ts
 models/SyntheticsTestOptionsMonitorOptions.ts

packages/datadog-api-client-v1/apis/SyntheticsApi.ts

@@ -9,6 +9,7 @@ import { isCodeInRange } from "../util";
 import { APIErrorResponse } from "../models/APIErrorResponse";
 import { SyntheticsAPITest } from "../models/SyntheticsAPITest";
 import { SyntheticsAPITestResultFull } from "../models/SyntheticsAPITestResultFull";
+import { SyntheticsBatchDetails } from "../models/SyntheticsBatchDetails";
 import { SyntheticsBrowserTest } from "../models/SyntheticsBrowserTest";
 import { SyntheticsBrowserTestResultFull } from "../models/SyntheticsBrowserTestResultFull";
 import { SyntheticsCITestBody } from "../models/SyntheticsCITestBody";
@@ -1082,6 +1083,61 @@ export class SyntheticsApiRequestFactory extends BaseAPIRequestFactory {
     return requestContext;
   }
 
+  /**
+   * Get a batch's updated details.
+   * Get details of batch
+   * @param batchId The ID of the batch.
+   */
+  public async getSyntheticsCIBatch(
+    batchId: string,
+    _options?: Configuration
+  ): Promise<RequestContext> {
+    const _config = _options || this.configuration;
+
+    // verify required parameter 'batchId' is not null or undefined
+    if (batchId === null || batchId === undefined) {
+      throw new RequiredError(
+        "Required parameter batchId was null or undefined when calling getSyntheticsCIBatch."
+      );
+    }
+
+    // Path Params
+    const localVarPath = "/api/v1/synthetics/ci/batch/{batch_id}".replace(
+      "{" + "batch_id" + "}",
+      encodeURIComponent(String(batchId))
+    );
+
+    // Make Request Context
+    const requestContext = getServer(
+      _config,
+      "SyntheticsApi.getSyntheticsCIBatch"
+    ).makeRequestContext(localVarPath, HttpMethod.GET);
+    requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8");
+    requestContext.setHttpConfig(_config.httpConfig);
+
+    // Query Params
+
+    // Header Params
+
+    // Form Params
+
+    // Body Params
+
+    let authMethod = null;
+    // Apply auth methods
+    authMethod = _config.authMethods["apiKeyAuth"];
+    if (authMethod) {
+      await authMethod.applySecurityAuthentication(requestContext);
+    }
+    // Apply auth methods
+    authMethod = _config.authMethods["appKeyAuth"];
+    if (authMethod) {
+      await authMethod.applySecurityAuthentication(requestContext);
+    }
+
+    return requestContext;
+  }
+
   /**
    * Get the detailed configuration associated with a Synthetics test.
    * Get a test configuration
@@ -2544,6 +2600,53 @@ export class SyntheticsApiResponseProcessor {
     );
   }
 
+  /**
+   * Unwraps the actual response sent by the server from the response context and deserializes the response content
+   * to the expected objects
+   *
+   * @params response Response returned by the server for a request to getSyntheticsCIBatch
+   * @throws ApiException if the response code was not in [200, 299]
+   */
+  public async getSyntheticsCIBatch(
+    response: ResponseContext
+  ): Promise<SyntheticsBatchDetails> {
+    const contentType = ObjectSerializer.normalizeMediaType(
+      response.headers["content-type"]
+    );
+    if (isCodeInRange("200", response.httpStatusCode)) {
+      const body: SyntheticsBatchDetails = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "SyntheticsBatchDetails",
+        ""
+      ) as SyntheticsBatchDetails;
+      return body;
+    }
+    if (isCodeInRange("404", response.httpStatusCode)) {
+      const body: APIErrorResponse = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "APIErrorResponse",
+        ""
+      ) as APIErrorResponse;
+      throw new ApiException<APIErrorResponse>(404, body);
+    }
+
+    // Work around for missing responses in specification, e.g. for petstore.yaml
+    if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+      const body: SyntheticsBatchDetails = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "SyntheticsBatchDetails",
+        ""
+      ) as SyntheticsBatchDetails;
+      return body;
+    }
+
+    const body = (await response.body.text()) || "";
+    throw new ApiException<string>(
+      response.httpStatusCode,
+      'Unknown API Status Code!\nBody: "' + body + '"'
+    );
+  }
+
   /**
    * Unwraps the actual response sent by the server from the response context and deserializes the response content
    * to the expected objects

packages/datadog-api-client-v1/index.ts

@@ -159,6 +159,7 @@ export {
   SyntheticsApiGetBrowserTestResultRequest,
   SyntheticsApiGetGlobalVariableRequest,
   SyntheticsApiGetPrivateLocationRequest,
+  SyntheticsApiGetSyntheticsCIBatchRequest,
   SyntheticsApiGetTestRequest,
   SyntheticsApiTriggerCITestsRequest,
   SyntheticsApiUpdateAPITestRequest,

packages/datadog-api-client-v1/models/ObjectSerializer.ts

@@ -295,6 +295,9 @@ import { SyntheticsAssertionJSONPathTarget } from "./SyntheticsAssertionJSONPath
 import { SyntheticsAssertionJSONPathTargetTarget } from "./SyntheticsAssertionJSONPathTargetTarget";
 import { SyntheticsAssertionTarget } from "./SyntheticsAssertionTarget";
 import { SyntheticsBasicAuth } from "./SyntheticsBasicAuth";
+import { SyntheticsBatchDetails } from "./SyntheticsBatchDetails";
+import { SyntheticsBatchDetailsData } from "./SyntheticsBatchDetailsData";
+import { SyntheticsBatchResult } from "./SyntheticsBatchResult";
 import { SyntheticsBrowserError } from "./SyntheticsBrowserError";
 import { SyntheticsBrowserTest } from "./SyntheticsBrowserTest";
 import { SyntheticsBrowserTestConfig } from "./SyntheticsBrowserTestConfig";
@@ -304,11 +307,11 @@ import { SyntheticsBrowserTestResultFullCheck } from "./SyntheticsBrowserTestRes
 import { SyntheticsBrowserTestResultShort } from "./SyntheticsBrowserTestResultShort";
 import { SyntheticsBrowserTestResultShortResult } from "./SyntheticsBrowserTestResultShortResult";
 import { SyntheticsBrowserVariable } from "./SyntheticsBrowserVariable";
+import { SyntheticsCIBatchMetadata } from "./SyntheticsCIBatchMetadata";
+import { SyntheticsCIBatchMetadataCI } from "./SyntheticsCIBatchMetadataCI";
+import { SyntheticsCIBatchMetadataGit } from "./SyntheticsCIBatchMetadataGit";
 import { SyntheticsCITest } from "./SyntheticsCITest";
 import { SyntheticsCITestBody } from "./SyntheticsCITestBody";
-import { SyntheticsCITestMetadata } from "./SyntheticsCITestMetadata";
-import { SyntheticsCITestMetadataCi } from "./SyntheticsCITestMetadataCi";
-import { SyntheticsCITestMetadataGit } from "./SyntheticsCITestMetadataGit";
 import { SyntheticsConfigVariable } from "./SyntheticsConfigVariable";
 import { SyntheticsCoreWebVitals } from "./SyntheticsCoreWebVitals";
 import { SyntheticsDeleteTestsPayload } from "./SyntheticsDeleteTestsPayload";
@@ -578,9 +581,11 @@ const enumsMap: Set<string> = new Set<string>([
   "SyntheticsGlobalVariableParseTestOptionsType",
   "SyntheticsGlobalVariableParserType",
   "SyntheticsPlayingTab",
+  "SyntheticsStatus",
   "SyntheticsStepType",
   "SyntheticsTestDetailsSubType",
   "SyntheticsTestDetailsType",
+  "SyntheticsTestExecutionRule",
   "SyntheticsTestMonitorStatus",
   "SyntheticsTestPauseStatus",
   "SyntheticsTestProcessStatus",
@@ -946,6 +951,9 @@ const typeMap: { [index: string]: any } = {
     SyntheticsAssertionJSONPathTargetTarget,
   SyntheticsAssertionTarget: SyntheticsAssertionTarget,
   SyntheticsBasicAuth: SyntheticsBasicAuth,
+  SyntheticsBatchDetails: SyntheticsBatchDetails,
+  SyntheticsBatchDetailsData: SyntheticsBatchDetailsData,
+  SyntheticsBatchResult: SyntheticsBatchResult,
   SyntheticsBrowserError: SyntheticsBrowserError,
   SyntheticsBrowserTest: SyntheticsBrowserTest,
   SyntheticsBrowserTestConfig: SyntheticsBrowserTestConfig,
@@ -956,11 +964,11 @@ const typeMap: { [index: string]: any } = {
   SyntheticsBrowserTestResultShortResult:
     SyntheticsBrowserTestResultShortResult,
   SyntheticsBrowserVariable: SyntheticsBrowserVariable,
+  SyntheticsCIBatchMetadata: SyntheticsCIBatchMetadata,
+  SyntheticsCIBatchMetadataCI: SyntheticsCIBatchMetadataCI,
+  SyntheticsCIBatchMetadataGit: SyntheticsCIBatchMetadataGit,
   SyntheticsCITest: SyntheticsCITest,
   SyntheticsCITestBody: SyntheticsCITestBody,
-  SyntheticsCITestMetadata: SyntheticsCITestMetadata,
-  SyntheticsCITestMetadataCi: SyntheticsCITestMetadataCi,
-  SyntheticsCITestMetadataGit: SyntheticsCITestMetadataGit,
   SyntheticsConfigVariable: SyntheticsConfigVariable,
   SyntheticsCoreWebVitals: SyntheticsCoreWebVitals,
   SyntheticsDeleteTestsPayload: SyntheticsDeleteTestsPayload,