datadog_api_client 2.47.0 → 2.49.0

data/lib/datadog_api_client/v1/models/synthetics_api_subtest_step.rb

@@ -0,0 +1,236 @@
+=begin
+#Datadog API V1 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V1
+  # The subtest step used in a Synthetics multi-step API test.
+  class SyntheticsAPISubtestStep
+    include BaseGenericModel
+
+    # Determines whether or not to continue with test if this step fails.
+    attr_accessor :allow_failure
+
+    # A boolean set to always execute this step even if the previous step failed or was skipped.
+    attr_accessor :always_execute
+
+    # Determines whether or not to exit the test if the step succeeds.
+    attr_accessor :exit_if_succeed
+
+    # Generate variables using JavaScript.
+    attr_accessor :extracted_values_from_script
+
+    # ID of the step.
+    attr_accessor :id
+
+    # Determines whether or not to consider the entire test as failed if this step fails.
+    # Can be used only if `allowFailure` is `true`.
+    attr_accessor :is_critical
+
+    # The name of the step.
+    attr_reader :name
+
+    # Object describing the retry strategy to apply to a Synthetic test.
+    attr_accessor :_retry
+
+    # Public ID of the test to be played as part of a `playSubTest` step type.
+    attr_reader :subtest_public_id
+
+    # The subtype of the Synthetic multi-step API subtest step.
+    attr_reader :subtype
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'allow_failure' => :'allowFailure',
+        :'always_execute' => :'alwaysExecute',
+        :'exit_if_succeed' => :'exitIfSucceed',
+        :'extracted_values_from_script' => :'extractedValuesFromScript',
+        :'id' => :'id',
+        :'is_critical' => :'isCritical',
+        :'name' => :'name',
+        :'_retry' => :'retry',
+        :'subtest_public_id' => :'subtestPublicId',
+        :'subtype' => :'subtype'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'allow_failure' => :'Boolean',
+        :'always_execute' => :'Boolean',
+        :'exit_if_succeed' => :'Boolean',
+        :'extracted_values_from_script' => :'String',
+        :'id' => :'String',
+        :'is_critical' => :'Boolean',
+        :'name' => :'String',
+        :'_retry' => :'SyntheticsTestOptionsRetry',
+        :'subtest_public_id' => :'String',
+        :'subtype' => :'SyntheticsAPISubtestStepSubtype'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::SyntheticsAPISubtestStep` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'allow_failure')
+        self.allow_failure = attributes[:'allow_failure']
+      end
+
+      if attributes.key?(:'always_execute')
+        self.always_execute = attributes[:'always_execute']
+      end
+
+      if attributes.key?(:'exit_if_succeed')
+        self.exit_if_succeed = attributes[:'exit_if_succeed']
+      end
+
+      if attributes.key?(:'extracted_values_from_script')
+        self.extracted_values_from_script = attributes[:'extracted_values_from_script']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'is_critical')
+        self.is_critical = attributes[:'is_critical']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'_retry')
+        self._retry = attributes[:'_retry']
+      end
+
+      if attributes.key?(:'subtest_public_id')
+        self.subtest_public_id = attributes[:'subtest_public_id']
+      end
+
+      if attributes.key?(:'subtype')
+        self.subtype = attributes[:'subtype']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @name.nil?
+      return false if @subtest_public_id.nil?
+      return false if @subtype.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param name [Object] Object to be assigned
+    # @!visibility private
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'invalid value for "name", name cannot be nil.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param subtest_public_id [Object] Object to be assigned
+    # @!visibility private
+    def subtest_public_id=(subtest_public_id)
+      if subtest_public_id.nil?
+        fail ArgumentError, 'invalid value for "subtest_public_id", subtest_public_id cannot be nil.'
+      end
+      @subtest_public_id = subtest_public_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param subtype [Object] Object to be assigned
+    # @!visibility private
+    def subtype=(subtype)
+      if subtype.nil?
+        fail ArgumentError, 'invalid value for "subtype", subtype cannot be nil.'
+      end
+      @subtype = subtype
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          allow_failure == o.allow_failure &&
+          always_execute == o.always_execute &&
+          exit_if_succeed == o.exit_if_succeed &&
+          extracted_values_from_script == o.extracted_values_from_script &&
+          id == o.id &&
+          is_critical == o.is_critical &&
+          name == o.name &&
+          _retry == o._retry &&
+          subtest_public_id == o.subtest_public_id &&
+          subtype == o.subtype &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [allow_failure, always_execute, exit_if_succeed, extracted_values_from_script, id, is_critical, name, _retry, subtest_public_id, subtype, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/synthetics_api_subtest_step_subtype.rb

@@ -0,0 +1,26 @@
+=begin
+#Datadog API V1 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V1
+  # The subtype of the Synthetic multi-step API subtest step.
+  class SyntheticsAPISubtestStepSubtype
+    include BaseEnumModel
+
+    PLAY_SUB_TEST = "playSubTest".freeze
+  end
+end

data/lib/datadog_api_client/v1/models/synthetics_list_tests_response.rb

@@ -38,7 +38,7 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.openapi_types
       {
-        :'tests' => :'Array<SyntheticsTestDetails>'
+        :'tests' => :'Array<SyntheticsTestDetailsWithoutSteps>'
       }
     end
 

data/lib/datadog_api_client/v1/models/synthetics_test_details.rb

@@ -49,7 +49,7 @@ module DatadogAPIClient::V1
     # Synthetic test.
     attr_accessor :status
 
-    # For browser test, the steps of the test.
+    # The steps of the test if they exist.
     attr_accessor :steps
 
     # The subtype of the Synthetic API test, `http`, `ssl`, `tcp`,

data/lib/datadog_api_client/v1/models/synthetics_test_details_without_steps.rb

@@ -0,0 +1,221 @@
+=begin
+#Datadog API V1 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V1
+  # Object containing details about your Synthetic test, without test steps.
+  class SyntheticsTestDetailsWithoutSteps
+    include BaseGenericModel
+
+    # Configuration object for a Synthetic test.
+    attr_accessor :config
+
+    # Object describing the creator of the shared element.
+    attr_accessor :creator
+
+    # Array of locations used to run the test.
+    attr_accessor :locations
+
+    # Notification message associated with the test.
+    attr_accessor :message
+
+    # The associated monitor ID.
+    attr_accessor :monitor_id
+
+    # Name of the test.
+    attr_accessor :name
+
+    # Object describing the extra options for a Synthetic test.
+    attr_accessor :options
+
+    # The test public ID.
+    attr_accessor :public_id
+
+    # Define whether you want to start (`live`) or pause (`paused`) a
+    # Synthetic test.
+    attr_accessor :status
+
+    # The subtype of the Synthetic API test, `http`, `ssl`, `tcp`,
+    # `dns`, `icmp`, `udp`, `websocket`, `grpc` or `multi`.
+    attr_accessor :subtype
+
+    # Array of tags attached to the test.
+    attr_accessor :tags
+
+    # Type of the Synthetic test, either `api` or `browser`.
+    attr_accessor :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'config' => :'config',
+        :'creator' => :'creator',
+        :'locations' => :'locations',
+        :'message' => :'message',
+        :'monitor_id' => :'monitor_id',
+        :'name' => :'name',
+        :'options' => :'options',
+        :'public_id' => :'public_id',
+        :'status' => :'status',
+        :'subtype' => :'subtype',
+        :'tags' => :'tags',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'config' => :'SyntheticsTestConfig',
+        :'creator' => :'Creator',
+        :'locations' => :'Array<String>',
+        :'message' => :'String',
+        :'monitor_id' => :'Integer',
+        :'name' => :'String',
+        :'options' => :'SyntheticsTestOptions',
+        :'public_id' => :'String',
+        :'status' => :'SyntheticsTestPauseStatus',
+        :'subtype' => :'SyntheticsTestDetailsSubType',
+        :'tags' => :'Array<String>',
+        :'type' => :'SyntheticsTestDetailsType'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::SyntheticsTestDetailsWithoutSteps` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'config')
+        self.config = attributes[:'config']
+      end
+
+      if attributes.key?(:'creator')
+        self.creator = attributes[:'creator']
+      end
+
+      if attributes.key?(:'locations')
+        if (value = attributes[:'locations']).is_a?(Array)
+          self.locations = value
+        end
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'monitor_id')
+        self.monitor_id = attributes[:'monitor_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'options')
+        self.options = attributes[:'options']
+      end
+
+      if attributes.key?(:'public_id')
+        self.public_id = attributes[:'public_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'subtype')
+        self.subtype = attributes[:'subtype']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          config == o.config &&
+          creator == o.creator &&
+          locations == o.locations &&
+          message == o.message &&
+          monitor_id == o.monitor_id &&
+          name == o.name &&
+          options == o.options &&
+          public_id == o.public_id &&
+          status == o.status &&
+          subtype == o.subtype &&
+          tags == o.tags &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [config, creator, locations, message, monitor_id, name, options, public_id, status, subtype, tags, type, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/tag_to_hosts.rb

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V1
-  # In this object, the key is the tag, the value is a list of host names that are reporting that tag.
+  # In this object, the key is the tag, and the value is a list of host names that are reporting that tag.
   class TagToHosts
     include BaseGenericModel
 
-    # A list of tags to apply to the host.
+    # A mapping of tags to host names
     attr_accessor :tags
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v1/models/widget_definition.rb

@@ -28,6 +28,7 @@ module DatadogAPIClient::V1
         [
           :'AlertGraphWidgetDefinition',
           :'AlertValueWidgetDefinition',
+          :'BarChartWidgetDefinition',
           :'ChangeWidgetDefinition',
           :'CheckStatusWidgetDefinition',
           :'DistributionWidgetDefinition',

data/lib/datadog_api_client/v1/models/{distribution_widget_histogram_request_type.rb → widget_histogram_request_type.rb}

@@ -18,7 +18,7 @@ require 'time'
 
 module DatadogAPIClient::V1
   # Request type for the histogram request.
-  class DistributionWidgetHistogramRequestType
+  class WidgetHistogramRequestType
     include BaseEnumModel
 
     HISTOGRAM = "histogram".freeze

data/lib/datadog_api_client/v1/models/widget_marker.rb

@@ -24,7 +24,7 @@ module DatadogAPIClient::V1
     # Combination of:
     #   - A severity error, warning, ok, or info
     #   - A line type: dashed, solid, or bold
-    # In this case of a Distribution widget, this can be set to be `x_axis_percentile`.
+    # In this case of a Distribution widget, this can be set to be `percentile`.
     attr_accessor :display_type
 
     # Label to display over the marker.
@@ -34,6 +34,8 @@ module DatadogAPIClient::V1
     attr_accessor :time
 
     # Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10.
+    # For Distribution widgets with `display_type` set to `percentile`, this should be
+    # a numeric percentile value (for example, "90" for P90).
     attr_reader :value
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/api/dora_metrics_api.rb

@@ -386,7 +386,7 @@ module DatadogAPIClient::V2
     #
     # @param deployment_id [String] The ID of the deployment event.
     # @param opts [Hash] the optional parameters
-    # @return [Array<(DORAFetchResponse, Integer, Hash)>] DORAFetchResponse data, response status code and response headers
+    # @return [Array<(DORADeploymentFetchResponse, Integer, Hash)>] DORADeploymentFetchResponse data, response status code and response headers
     def get_dora_deployment_with_http_info(deployment_id, opts = {})
 
       if @api_client.config.debugging
@@ -414,7 +414,7 @@ module DatadogAPIClient::V2
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'DORAFetchResponse'
+      return_type = opts[:debug_return_type] || 'DORADeploymentFetchResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
@@ -451,7 +451,7 @@ module DatadogAPIClient::V2
     #
     # @param failure_id [String] The ID of the failure event.
     # @param opts [Hash] the optional parameters
-    # @return [Array<(DORAFetchResponse, Integer, Hash)>] DORAFetchResponse data, response status code and response headers
+    # @return [Array<(DORAFailureFetchResponse, Integer, Hash)>] DORAFailureFetchResponse data, response status code and response headers
     def get_dora_failure_with_http_info(failure_id, opts = {})
 
       if @api_client.config.debugging
@@ -479,7 +479,7 @@ module DatadogAPIClient::V2
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'DORAFetchResponse'
+      return_type = opts[:debug_return_type] || 'DORAFailureFetchResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
@@ -516,7 +516,7 @@ module DatadogAPIClient::V2
     #
     # @param body [DORAListDeploymentsRequest] 
     # @param opts [Hash] the optional parameters
-    # @return [Array<(DORAListResponse, Integer, Hash)>] DORAListResponse data, response status code and response headers
+    # @return [Array<(DORADeploymentsListResponse, Integer, Hash)>] DORADeploymentsListResponse data, response status code and response headers
     def list_dora_deployments_with_http_info(body, opts = {})
 
       if @api_client.config.debugging
@@ -546,7 +546,7 @@ module DatadogAPIClient::V2
       post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'DORAListResponse'
+      return_type = opts[:debug_return_type] || 'DORADeploymentsListResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
@@ -583,7 +583,7 @@ module DatadogAPIClient::V2
     #
     # @param body [DORAListFailuresRequest] 
     # @param opts [Hash] the optional parameters
-    # @return [Array<(DORAListResponse, Integer, Hash)>] DORAListResponse data, response status code and response headers
+    # @return [Array<(DORAFailuresListResponse, Integer, Hash)>] DORAFailuresListResponse data, response status code and response headers
     def list_dora_failures_with_http_info(body, opts = {})
 
       if @api_client.config.debugging
@@ -613,7 +613,7 @@ module DatadogAPIClient::V2
       post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'DORAListResponse'
+      return_type = opts[:debug_return_type] || 'DORAFailuresListResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

data/lib/datadog_api_client/v2/api/events_api.rb

@@ -43,8 +43,6 @@ module DatadogAPIClient::V2
     #
     # ❌ For use cases involving other event categories, use the V1 endpoint or reach out to [support](https://www.datadoghq.com/support/).
     #
-    # ❌ Notifications are not yet supported for events sent to this endpoint. Use the V1 endpoint for notification functionality.
-    #
     # @param body [EventCreateRequestPayload] Event creation request payload.
     # @param opts [Hash] the optional parameters
     # @return [Array<(EventCreateResponsePayload, Integer, Hash)>] EventCreateResponsePayload data, response status code and response headers

data/lib/datadog_api_client/v2/api/fleet_automation_api.rb

@@ -693,7 +693,7 @@ module DatadogAPIClient::V2
     # Use the `page_number` and `page_size` query parameters to paginate through results.
     #
     # @param opts [Hash] the optional parameters
-    # @option opts [Integer] :page_number Page number for pagination (must be greater than 0).
+    # @option opts [Integer] :page_number Page number for pagination (starts at 0).
     # @option opts [Integer] :page_size Number of results per page (must be greater than 0 and less than or equal to 100).
     # @option opts [String] :sort_attribute Attribute to sort by.
     # @option opts [Boolean] :sort_descending Sort order (true for descending, false for ascending).
@@ -711,8 +711,8 @@ module DatadogAPIClient::V2
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: FleetAutomationAPI.list_fleet_agents ...'
       end
-      if @api_client.config.client_side_validation && !opts[:'page_number'].nil? && opts[:'page_number'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"page_number"]" when calling FleetAutomationAPI.list_fleet_agents, must be greater than or equal to 1.'
+      if @api_client.config.client_side_validation && !opts[:'page_number'].nil? && opts[:'page_number'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"page_number"]" when calling FleetAutomationAPI.list_fleet_agents, must be greater than or equal to 0.'
       end
       if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
         fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FleetAutomationAPI.list_fleet_agents, must be smaller than or equal to 100.'