datadog_api_client 1.0.0.beta.3 → 1.0.0

data/docs/v1/SLOListResponse.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **data** | [**Array<ServiceLevelObjective>**](ServiceLevelObjective.md) | An array of service level objective objects. | [optional] |
 | **errors** | **Array<String>** | An array of error messages. Each endpoint documents how/whether this field is used. | [optional] |
+| **metadata** | [**SLOListResponseMetadata**](SLOListResponseMetadata.md) |  | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'datadog_api_client/v1'
 
 instance = DatadogAPIClient::V1::SLOListResponse.new(
   data: null,
-  errors: null
+  errors: null,
+  metadata: null
 )
 ```
 

data/docs/v1/SLOListResponseMetadata.md

@@ -0,0 +1,18 @@
+# DatadogAPIClient::V1::SLOListResponseMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | [**SLOListResponseMetadataPage**](SLOListResponseMetadataPage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'datadog_api_client/v1'
+
+instance = DatadogAPIClient::V1::SLOListResponseMetadata.new(
+  page: null
+)
+```
+

data/docs/v1/SLOListResponseMetadataPage.md

@@ -0,0 +1,20 @@
+# DatadogAPIClient::V1::SLOListResponseMetadataPage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_count** | **Integer** | The total number of resources that could be retrieved ignoring the parameters and filters in the request. | [optional] |
+| **total_filtered_count** | **Integer** | The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages. | [optional] |
+
+## Example
+
+```ruby
+require 'datadog_api_client/v1'
+
+instance = DatadogAPIClient::V1::SLOListResponseMetadataPage.new(
+  total_count: null,
+  total_filtered_count: null
+)
+```
+

data/docs/v1/SLOResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**ServiceLevelObjective**](ServiceLevelObjective.md) |  | [optional] |
+| **data** | [**SLOResponseData**](SLOResponseData.md) |  | [optional] |
 | **errors** | **Array<String>** | An array of error messages. Each endpoint documents how/whether this field is used. | [optional] |
 
 ## Example

data/docs/v1/SLOResponseData.md

@@ -0,0 +1,44 @@
+# DatadogAPIClient::V1::SLOResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **configured_alert_ids** | **Array<Integer>** | A list of SLO monitors IDs that reference this SLO. This field is returned only when `with_configured_alert_ids` parameter is true in query. | [optional] |
+| **created_at** | **Integer** | Creation timestamp (UNIX time in seconds)  Always included in service level objective responses. | [optional][readonly] |
+| **creator** | [**Creator**](Creator.md) |  | [optional] |
+| **description** | **String** | A user-defined description of the service level objective.  Always included in service level objective responses (but may be `null`). Optional in create/update requests. | [optional] |
+| **groups** | **Array<String>** | A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective.  Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. | [optional] |
+| **id** | **String** | A unique identifier for the service level objective object.  Always included in service level objective responses. | [optional][readonly] |
+| **modified_at** | **Integer** | Modification timestamp (UNIX time in seconds)  Always included in service level objective responses. | [optional][readonly] |
+| **monitor_ids** | **Array<Integer>** | A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. | [optional] |
+| **monitor_tags** | **Array<String>** | The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). | [optional] |
+| **name** | **String** | The name of the service level objective object. | [optional] |
+| **query** | [**ServiceLevelObjectiveQuery**](ServiceLevelObjectiveQuery.md) |  | [optional] |
+| **tags** | **Array<String>** | A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. | [optional] |
+| **thresholds** | [**Array<SLOThreshold>**](SLOThreshold.md) | The thresholds (timeframes and associated targets) for this service level objective object. | [optional] |
+| **type** | [**SLOType**](SLOType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'datadog_api_client/v1'
+
+instance = DatadogAPIClient::V1::SLOResponseData.new(
+  configured_alert_ids: [123,456,789],
+  created_at: null,
+  creator: null,
+  description: null,
+  groups: ["env:prod","role:mysql"],
+  id: null,
+  modified_at: null,
+  monitor_ids: null,
+  monitor_tags: null,
+  name: Custom Metric SLO,
+  query: null,
+  tags: ["env:prod","app:core"],
+  thresholds: [{"target":95,"timeframe":"7d"},{"target":95,"timeframe":"30d","warning":97}],
+  type: null
+)
+```
+

data/docs/v1/ServiceLevelObjectivesAPI.md

@@ -268,7 +268,7 @@ end
 
 ## get_slo
 
-> <SLOResponse> get_slo(slo_id)
+> <SLOResponse> get_slo(slo_id, opts)
 
 Get an SLO's details
 
@@ -280,10 +280,13 @@ Get a service level objective object.
 require 'datadog_api_client'
 api_instance = DatadogAPIClient::V1::ServiceLevelObjectivesAPI.new
 slo_id = 'slo_id_example' # String | The ID of the service level objective object.
+opts = {
+  with_configured_alert_ids: true # Boolean | Get the IDs of SLO monitors that reference this SLO.
+}
 
 begin
   # Get an SLO's details
-  result = api_instance.get_slo(slo_id)
+  result = api_instance.get_slo(slo_id, opts)
   p result
 rescue DatadogAPIClient::V1::APIError => e
   puts "Error when calling ServiceLevelObjectivesAPI->get_slo: #{e}"
@@ -294,12 +297,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SLOResponse>, Integer, Hash)> get_slo_with_http_info(slo_id)
+> <Array(<SLOResponse>, Integer, Hash)> get_slo_with_http_info(slo_id, opts)
 
 ```ruby
 begin
   # Get an SLO's details
-  data, status_code, headers = api_instance.get_slo_with_http_info(slo_id)
+  data, status_code, headers = api_instance.get_slo_with_http_info(slo_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SLOResponse>
@@ -313,6 +316,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **slo_id** | **String** | The ID of the service level objective object. |  |
+| **with_configured_alert_ids** | **Boolean** | Get the IDs of SLO monitors that reference this SLO. | [optional] |
 
 ### Return type
 

data/docs/v1/SyntheticsAPI.md

@@ -8,27 +8,25 @@ All URIs are relative to *https://api.datadoghq.com*
 | [**create_private_location**](SyntheticsAPI.md#create_private_location) | **POST** /api/v1/synthetics/private-locations | Create a private location |
 | [**create_synthetics_api_test**](SyntheticsAPI.md#create_synthetics_api_test) | **POST** /api/v1/synthetics/tests/api | Create an API test |
 | [**create_synthetics_browser_test**](SyntheticsAPI.md#create_synthetics_browser_test) | **POST** /api/v1/synthetics/tests/browser | Create a browser test |
-| [**create_test**](SyntheticsAPI.md#create_test) | **POST** /api/v1/synthetics/tests | Create a test |
 | [**delete_global_variable**](SyntheticsAPI.md#delete_global_variable) | **DELETE** /api/v1/synthetics/variables/{variable_id} | Delete a global variable |
 | [**delete_private_location**](SyntheticsAPI.md#delete_private_location) | **DELETE** /api/v1/synthetics/private-locations/{location_id} | Delete a private location |
 | [**delete_tests**](SyntheticsAPI.md#delete_tests) | **POST** /api/v1/synthetics/tests/delete | Delete tests |
 | [**edit_global_variable**](SyntheticsAPI.md#edit_global_variable) | **PUT** /api/v1/synthetics/variables/{variable_id} | Edit a global variable |
 | [**get_api_test**](SyntheticsAPI.md#get_api_test) | **GET** /api/v1/synthetics/tests/api/{public_id} | Get an API test |
-| [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results) | **GET** /api/v1/synthetics/tests/{public_id}/results | Get the test's latest results summaries (API) |
-| [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result) | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id} | Get a test result (API) |
-| [**get_browser_test**](SyntheticsAPI.md#get_browser_test) | **GET** /api/v1/synthetics/tests/browser/{public_id} | Get a test configuration (browser) |
-| [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results | Get the test's latest results summaries (browser) |
-| [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a test result (browser) |
+| [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results) | **GET** /api/v1/synthetics/tests/{public_id}/results | Get an API test's latest results summaries |
+| [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result) | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id} | Get an API test result |
+| [**get_browser_test**](SyntheticsAPI.md#get_browser_test) | **GET** /api/v1/synthetics/tests/browser/{public_id} | Get a browser test |
+| [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results | Get a browser test's latest results summaries |
+| [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a browser test result |
 | [**get_global_variable**](SyntheticsAPI.md#get_global_variable) | **GET** /api/v1/synthetics/variables/{variable_id} | Get a global variable |
 | [**get_private_location**](SyntheticsAPI.md#get_private_location) | **GET** /api/v1/synthetics/private-locations/{location_id} | Get a private location |
-| [**get_test**](SyntheticsAPI.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration (API) |
+| [**get_test**](SyntheticsAPI.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration |
 | [**list_locations**](SyntheticsAPI.md#list_locations) | **GET** /api/v1/synthetics/locations | Get all locations (public and private) |
 | [**list_tests**](SyntheticsAPI.md#list_tests) | **GET** /api/v1/synthetics/tests | Get the list of all tests |
-| [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger some Synthetics tests for CI |
+| [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger tests from CI/CD pipelines |
 | [**update_api_test**](SyntheticsAPI.md#update_api_test) | **PUT** /api/v1/synthetics/tests/api/{public_id} | Edit an API test |
 | [**update_browser_test**](SyntheticsAPI.md#update_browser_test) | **PUT** /api/v1/synthetics/tests/browser/{public_id} | Edit a browser test |
 | [**update_private_location**](SyntheticsAPI.md#update_private_location) | **PUT** /api/v1/synthetics/private-locations/{location_id} | Edit a private location |
-| [**update_test**](SyntheticsAPI.md#update_test) | **PUT** /api/v1/synthetics/tests/{public_id} | Edit a test |
 | [**update_test_pause_status**](SyntheticsAPI.md#update_test_pause_status) | **PUT** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test |
 
 
@@ -280,68 +278,6 @@ end
 - **Accept**: application/json
 
 
-## create_test
-
-> <SyntheticsTestDetails> create_test(body)
-
-Create a test
-
-Create a Synthetic test.
-
-### Examples
-
-```ruby
-require 'datadog_api_client'
-api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
-body = DatadogAPIClient::V1::SyntheticsTestDetails.new # SyntheticsTestDetails | Details of the test to create.
-
-begin
-  # Create a test
-  result = api_instance.create_test(body)
-  p result
-rescue DatadogAPIClient::V1::APIError => e
-  puts "Error when calling SyntheticsAPI->create_test: #{e}"
-end
-```
-
-#### Using the create_test_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<SyntheticsTestDetails>, Integer, Hash)> create_test_with_http_info(body)
-
-```ruby
-begin
-  # Create a test
-  data, status_code, headers = api_instance.create_test_with_http_info(body)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <SyntheticsTestDetails>
-rescue DatadogAPIClient::V1::APIError => e
-  puts "Error when calling SyntheticsAPI->create_test_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**SyntheticsTestDetails**](SyntheticsTestDetails.md) | Details of the test to create. |  |
-
-### Return type
-
-[**SyntheticsTestDetails**](SyntheticsTestDetails.md)
-
-### Authorization
-
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
 ## delete_global_variable
 
 > delete_global_variable(variable_id)
@@ -656,7 +592,7 @@ end
 
 > <SyntheticsGetAPITestLatestResultsResponse> get_api_test_latest_results(public_id, opts)
 
-Get the test's latest results summaries (API)
+Get an API test's latest results summaries
 
 Get the last 50 test results summaries for a given Synthetics API test.
 
@@ -673,7 +609,7 @@ opts = {
 }
 
 begin
-  # Get the test's latest results summaries (API)
+  # Get an API test's latest results summaries
   result = api_instance.get_api_test_latest_results(public_id, opts)
   p result
 rescue DatadogAPIClient::V1::APIError => e
@@ -689,7 +625,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get the test's latest results summaries (API)
+  # Get an API test's latest results summaries
   data, status_code, headers = api_instance.get_api_test_latest_results_with_http_info(public_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -726,7 +662,7 @@ end
 
 > <SyntheticsAPITestResultFull> get_api_test_result(public_id, result_id)
 
-Get a test result (API)
+Get an API test result
 
 Get a specific full result from a given (API) Synthetic test.
 
@@ -739,7 +675,7 @@ public_id = 'public_id_example' # String | The public ID of the API test to whic
 result_id = 'result_id_example' # String | The ID of the result to get.
 
 begin
-  # Get a test result (API)
+  # Get an API test result
   result = api_instance.get_api_test_result(public_id, result_id)
   p result
 rescue DatadogAPIClient::V1::APIError => e
@@ -755,7 +691,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get a test result (API)
+  # Get an API test result
   data, status_code, headers = api_instance.get_api_test_result_with_http_info(public_id, result_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -790,7 +726,7 @@ end
 
 > <SyntheticsBrowserTest> get_browser_test(public_id)
 
-Get a test configuration (browser)
+Get a browser test
 
 Get the detailed configuration (including steps) associated with a Synthetic browser test.
 
@@ -802,7 +738,7 @@ api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
 public_id = 'public_id_example' # String | The public ID of the test to get details from.
 
 begin
-  # Get a test configuration (browser)
+  # Get a browser test
   result = api_instance.get_browser_test(public_id)
   p result
 rescue DatadogAPIClient::V1::APIError => e
@@ -818,7 +754,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get a test configuration (browser)
+  # Get a browser test
   data, status_code, headers = api_instance.get_browser_test_with_http_info(public_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -852,7 +788,7 @@ end
 
 > <SyntheticsGetBrowserTestLatestResultsResponse> get_browser_test_latest_results(public_id, opts)
 
-Get the test's latest results summaries (browser)
+Get a browser test's latest results summaries
 
 Get the last 50 test results summaries for a given Synthetics Browser test.
 
@@ -869,7 +805,7 @@ opts = {
 }
 
 begin
-  # Get the test's latest results summaries (browser)
+  # Get a browser test's latest results summaries
   result = api_instance.get_browser_test_latest_results(public_id, opts)
   p result
 rescue DatadogAPIClient::V1::APIError => e
@@ -885,7 +821,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get the test's latest results summaries (browser)
+  # Get a browser test's latest results summaries
   data, status_code, headers = api_instance.get_browser_test_latest_results_with_http_info(public_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -922,7 +858,7 @@ end
 
 > <SyntheticsBrowserTestResultFull> get_browser_test_result(public_id, result_id)
 
-Get a test result (browser)
+Get a browser test result
 
 Get a specific full result from a given (browser) Synthetic test.
 
@@ -935,7 +871,7 @@ public_id = 'public_id_example' # String | The public ID of the browser test to
 result_id = 'result_id_example' # String | The ID of the result to get.
 
 begin
-  # Get a test result (browser)
+  # Get a browser test result
   result = api_instance.get_browser_test_result(public_id, result_id)
   p result
 rescue DatadogAPIClient::V1::APIError => e
@@ -951,7 +887,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get a test result (browser)
+  # Get a browser test result
   data, status_code, headers = api_instance.get_browser_test_result_with_http_info(public_id, result_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -1110,7 +1046,7 @@ end
 
 > <SyntheticsTestDetails> get_test(public_id)
 
-Get a test configuration (API)
+Get a test configuration
 
 Get the detailed configuration associated with a Synthetics test.
 
@@ -1122,7 +1058,7 @@ api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
 public_id = 'public_id_example' # String | The public ID of the test to get details from.
 
 begin
-  # Get a test configuration (API)
+  # Get a test configuration
   result = api_instance.get_test(public_id)
   p result
 rescue DatadogAPIClient::V1::APIError => e
@@ -1138,7 +1074,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get a test configuration (API)
+  # Get a test configuration
   data, status_code, headers = api_instance.get_test_with_http_info(public_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -1290,7 +1226,7 @@ This endpoint does not need any parameter.
 
 > <SyntheticsTriggerCITestsResponse> trigger_ci_tests(body)
 
-Trigger some Synthetics tests for CI
+Trigger tests from CI/CD pipelines
 
 Trigger a set of Synthetics tests for continuous integration.
 
@@ -1302,7 +1238,7 @@ api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
 body = DatadogAPIClient::V1::SyntheticsCITestBody.new # SyntheticsCITestBody | Details of the test to trigger.
 
 begin
-  # Trigger some Synthetics tests for CI
+  # Trigger tests from CI/CD pipelines
   result = api_instance.trigger_ci_tests(body)
   p result
 rescue DatadogAPIClient::V1::APIError => e
@@ -1318,7 +1254,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Trigger some Synthetics tests for CI
+  # Trigger tests from CI/CD pipelines
   data, status_code, headers = api_instance.trigger_ci_tests_with_http_info(body)
   p status_code # => 2xx
   p headers # => { ... }
@@ -1540,70 +1476,6 @@ end
 - **Accept**: application/json
 
 
-## update_test
-
-> <SyntheticsTestDetails> update_test(public_id, body)
-
-Edit a test
-
-Edit the configuration of a Synthetic test.
-
-### Examples
-
-```ruby
-require 'datadog_api_client'
-api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
-public_id = 'public_id_example' # String | The public ID of the test to get details from.
-body = DatadogAPIClient::V1::SyntheticsTestDetails.new # SyntheticsTestDetails | New test details to be saved.
-
-begin
-  # Edit a test
-  result = api_instance.update_test(public_id, body)
-  p result
-rescue DatadogAPIClient::V1::APIError => e
-  puts "Error when calling SyntheticsAPI->update_test: #{e}"
-end
-```
-
-#### Using the update_test_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<SyntheticsTestDetails>, Integer, Hash)> update_test_with_http_info(public_id, body)
-
-```ruby
-begin
-  # Edit a test
-  data, status_code, headers = api_instance.update_test_with_http_info(public_id, body)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <SyntheticsTestDetails>
-rescue DatadogAPIClient::V1::APIError => e
-  puts "Error when calling SyntheticsAPI->update_test_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the test to get details from. |  |
-| **body** | [**SyntheticsTestDetails**](SyntheticsTestDetails.md) | New test details to be saved. |  |
-
-### Return type
-
-[**SyntheticsTestDetails**](SyntheticsTestDetails.md)
-
-### Authorization
-
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
 ## update_test_pause_status
 
 > Boolean update_test_pause_status(public_id, body)