datadog_api_client 2.52.0 → 2.53.0

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

@@ -0,0 +1,108 @@
+=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
+  # Return criteria for retention queries.
+  class RetentionReturnCriteria
+    include BaseGenericModel
+
+    # Product Analytics event query.
+    attr_reader :base_query
+
+    # Time interval for return criteria.
+    attr_accessor :time_interval
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'base_query' => :'base_query',
+        :'time_interval' => :'time_interval'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'base_query' => :'ProductAnalyticsBaseQuery',
+        :'time_interval' => :'RetentionReturnCriteriaTimeInterval'
+      }
+    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::RetentionReturnCriteria` initialize method"
+      end
+
+      # 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))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::RetentionReturnCriteria`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'base_query')
+        self.base_query = attributes[:'base_query']
+      end
+
+      if attributes.key?(:'time_interval')
+        self.time_interval = attributes[:'time_interval']
+      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 @base_query.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param base_query [Object] Object to be assigned
+    # @!visibility private
+    def base_query=(base_query)
+      if base_query.nil?
+        fail ArgumentError, 'invalid value for "base_query", base_query cannot be nil.'
+      end
+      @base_query = base_query
+    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 &&
+          base_query == o.base_query &&
+          time_interval == o.time_interval
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [base_query, time_interval].hash
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+=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
+  # Time interval for return criteria.
+  class RetentionReturnCriteriaTimeInterval
+    include BaseGenericModel
+
+    # Type of time interval for return criteria.
+    attr_reader :type
+
+    # Unit of time for retention return criteria interval.
+    attr_reader :unit
+
+    # Value of the time interval.
+    attr_reader :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'unit' => :'unit',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'type' => :'RetentionReturnCriteriaTimeIntervalType',
+        :'unit' => :'RetentionReturnCriteriaTimeIntervalUnit',
+        :'value' => :'Float'
+      }
+    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::RetentionReturnCriteriaTimeInterval` initialize method"
+      end
+
+      # 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))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::RetentionReturnCriteriaTimeInterval`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      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 @type.nil?
+      return false if @unit.nil?
+      return false if @value.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param type [Object] Object to be assigned
+    # @!visibility private
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'invalid value for "type", type cannot be nil.'
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param unit [Object] Object to be assigned
+    # @!visibility private
+    def unit=(unit)
+      if unit.nil?
+        fail ArgumentError, 'invalid value for "unit", unit cannot be nil.'
+      end
+      @unit = unit
+    end
+
+    # Custom attribute writer method with validation
+    # @param value [Object] Object to be assigned
+    # @!visibility private
+    def value=(value)
+      if value.nil?
+        fail ArgumentError, 'invalid value for "value", value cannot be nil.'
+      end
+      @value = value
+    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 &&
+          type == o.type &&
+          unit == o.unit &&
+          value == o.value
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [type, unit, value].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/retention_return_criteria_time_interval_type.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
+  # Type of time interval for return criteria.
+  class RetentionReturnCriteriaTimeIntervalType
+    include BaseEnumModel
+
+    FIXED = "fixed".freeze
+  end
+end

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

@@ -0,0 +1,28 @@
+=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
+  # Unit of time for retention return criteria interval.
+  class RetentionReturnCriteriaTimeIntervalUnit
+    include BaseEnumModel
+
+    DAY = "day".freeze
+    WEEK = "week".freeze
+    MONTH = "month".freeze
+  end
+end

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

@@ -0,0 +1,160 @@
+=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
+  # Search configuration for retention queries.
+  class RetentionSearch
+    include BaseGenericModel
+
+    # Cohort criteria for retention queries.
+    attr_reader :cohort_criteria
+
+    # Filters for retention queries.
+    attr_accessor :filters
+
+    # Entity to track for retention.
+    attr_reader :retention_entity
+
+    # Condition for counting user return.
+    attr_reader :return_condition
+
+    # Return criteria for retention queries.
+    attr_accessor :return_criteria
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'cohort_criteria' => :'cohort_criteria',
+        :'filters' => :'filters',
+        :'retention_entity' => :'retention_entity',
+        :'return_condition' => :'return_condition',
+        :'return_criteria' => :'return_criteria'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'cohort_criteria' => :'RetentionCohortCriteria',
+        :'filters' => :'RetentionFilters',
+        :'retention_entity' => :'RetentionEntity',
+        :'return_condition' => :'RetentionReturnCondition',
+        :'return_criteria' => :'RetentionReturnCriteria'
+      }
+    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::RetentionSearch` initialize method"
+      end
+
+      # 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))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::RetentionSearch`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'cohort_criteria')
+        self.cohort_criteria = attributes[:'cohort_criteria']
+      end
+
+      if attributes.key?(:'filters')
+        self.filters = attributes[:'filters']
+      end
+
+      if attributes.key?(:'retention_entity')
+        self.retention_entity = attributes[:'retention_entity']
+      end
+
+      if attributes.key?(:'return_condition')
+        self.return_condition = attributes[:'return_condition']
+      end
+
+      if attributes.key?(:'return_criteria')
+        self.return_criteria = attributes[:'return_criteria']
+      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 @cohort_criteria.nil?
+      return false if @retention_entity.nil?
+      return false if @return_condition.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param cohort_criteria [Object] Object to be assigned
+    # @!visibility private
+    def cohort_criteria=(cohort_criteria)
+      if cohort_criteria.nil?
+        fail ArgumentError, 'invalid value for "cohort_criteria", cohort_criteria cannot be nil.'
+      end
+      @cohort_criteria = cohort_criteria
+    end
+
+    # Custom attribute writer method with validation
+    # @param retention_entity [Object] Object to be assigned
+    # @!visibility private
+    def retention_entity=(retention_entity)
+      if retention_entity.nil?
+        fail ArgumentError, 'invalid value for "retention_entity", retention_entity cannot be nil.'
+      end
+      @retention_entity = retention_entity
+    end
+
+    # Custom attribute writer method with validation
+    # @param return_condition [Object] Object to be assigned
+    # @!visibility private
+    def return_condition=(return_condition)
+      if return_condition.nil?
+        fail ArgumentError, 'invalid value for "return_condition", return_condition cannot be nil.'
+      end
+      @return_condition = return_condition
+    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 &&
+          cohort_criteria == o.cohort_criteria &&
+          filters == o.filters &&
+          retention_entity == o.retention_entity &&
+          return_condition == o.return_condition &&
+          return_criteria == o.return_criteria
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [cohort_criteria, filters, retention_entity, return_condition, return_criteria].hash
+    end
+  end
+end

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

@@ -39,10 +39,10 @@ module DatadogAPIClient::V1
     # Number of steps.
     attr_accessor :number_of_steps
 
-    #
+    # Filter applied to occurrence counts when building a Product Analytics audience.
     attr_accessor :occurrences
 
-    # Query string.
+    # RUM event search query used to filter views or actions.
     attr_reader :query_string
 
     # Source.

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V1
-  # 
+  # SLO count definition using a bad events formula alongside a good events formula.
   class SLOCountDefinitionWithBadEventsFormula
     include BaseGenericModel
 

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V1
-  # 
+  # SLO count definition using a total events formula alongside a good events formula.
   class SLOCountDefinitionWithTotalEventsFormula
     include BaseGenericModel
 

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

@@ -32,6 +32,8 @@ module DatadogAPIClient::V1
     ASSERT_PAGE_LACKS = "assertPageLacks".freeze
     ASSERT_REQUESTS = "assertRequests".freeze
     CLICK = "click".freeze
+    DRAG = "drag".freeze
+    DROP = "drop".freeze
     EXTRACT_FROM_JAVASCRIPT = "extractFromJavascript".freeze
     EXTRACT_FROM_EMAIL_BODY = "extractFromEmailBody".freeze
     EXTRACT_VARIABLE = "extractVariable".freeze