datadog_api_client 2.58.0 → 2.59.1

data/lib/datadog_api_client/v2/models/product_analytics_retention_return_criteria.rb

@@ -0,0 +1,136 @@
+=begin
+#Datadog API V2 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::V2
+  # Defines the event that counts as a return, and the window in which it must occur.
+  class ProductAnalyticsRetentionReturnCriteria
+    include BaseGenericModel
+
+    # A query definition discriminated by the `data_source` field.
+    # Use `product_analytics` for standard event queries, or
+    # `product_analytics_occurrence` for occurrence-filtered queries.
+    attr_reader :base_query
+
+    # A retention interval, either aligned to calendar boundaries or of a fixed length.
+    # Cohort criteria use calendar intervals; return criteria use fixed intervals.
+    attr_accessor :time_interval
+
+    attr_accessor :additional_properties
+
+    # 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' => :'ProductAnalyticsRetentionTimeInterval'
+      }
+    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::V2::ProductAnalyticsRetentionReturnCriteria` 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?(:'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
+
+    # 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 &&
+          base_query == o.base_query &&
+          time_interval == o.time_interval &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [base_query, time_interval, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/product_analytics_retention_return_period_scope.rb

@@ -0,0 +1,144 @@
+=begin
+#Datadog API V2 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::V2
+  # Narrows a retention query to a single return-period column.
+  class ProductAnalyticsRetentionReturnPeriodScope
+    include BaseGenericModel
+
+    # Selects a cohort or return period by its zero-based position in the grid.
+    attr_reader :target
+
+    # The discriminator identifying a scope narrowed to one return period.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'target' => :'target',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'target' => :'ProductAnalyticsRetentionIndexTarget',
+        :'type' => :'ProductAnalyticsRetentionReturnPeriodScopeType'
+      }
+    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::V2::ProductAnalyticsRetentionReturnPeriodScope` 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?(:'target')
+        self.target = attributes[:'target']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 @target.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param target [Object] Object to be assigned
+    # @!visibility private
+    def target=(target)
+      if target.nil?
+        fail ArgumentError, 'invalid value for "target", target cannot be nil.'
+      end
+      @target = target
+    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
+
+    # 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 &&
+          target == o.target &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [target, type, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/product_analytics_retention_return_period_scope_type.rb

@@ -0,0 +1,26 @@
+=begin
+#Datadog API V2 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::V2
+  # The discriminator identifying a scope narrowed to one return period.
+  class ProductAnalyticsRetentionReturnPeriodScopeType
+    include BaseEnumModel
+
+    RETURN_PERIOD = "return_period".freeze
+  end
+end

data/lib/datadog_api_client/v2/models/product_analytics_retention_scope.rb

@@ -0,0 +1,65 @@
+=begin
+#Datadog API V2 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::V2
+  # Restricts a retention query to part of the grid, so that results can be examined in detail.
+  # Omit it to compute the whole grid.
+  module ProductAnalyticsRetentionScope
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'ProductAnalyticsRetentionCohortScope',
+          :'ProductAnalyticsRetentionReturnPeriodScope',
+          :'ProductAnalyticsRetentionCellScope'
+        ]
+      end
+      # Builds the object
+      # @param data [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            next if typed_data.respond_to?(:_unparsed) && typed_data._unparsed
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
+        end
+      end
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/product_analytics_retention_search.rb

@@ -0,0 +1,186 @@
+=begin
+#Datadog API V2 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::V2
+  # Defines the cohort and return criteria that make up a retention query.
+  class ProductAnalyticsRetentionSearch
+    include BaseGenericModel
+
+    # Defines the event that places an entity into a cohort, and how cohorts are bucketed over time.
+    attr_reader :cohort_criteria
+
+    # Filters narrowing the events considered by a retention query.
+    attr_accessor :filters
+
+    # The entity whose retention is measured.
+    attr_reader :retention_entity
+
+    # When an entity counts as having returned. Use `conversion_on` to count only entities that
+    # returned during the period itself, or `conversion_on_or_after` to also count later returns.
+    attr_reader :return_condition
+
+    # Defines the event that counts as a return, and the window in which it must occur.
+    attr_accessor :return_criteria
+
+    attr_accessor :additional_properties
+
+    # 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' => :'ProductAnalyticsRetentionCohortCriteria',
+        :'filters' => :'ProductAnalyticsRetentionFilters',
+        :'retention_entity' => :'ProductAnalyticsRetentionEntity',
+        :'return_condition' => :'ProductAnalyticsRetentionReturnCondition',
+        :'return_criteria' => :'ProductAnalyticsRetentionReturnCriteria'
+      }
+    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::V2::ProductAnalyticsRetentionSearch` 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?(:'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
+
+    # 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 &&
+          cohort_criteria == o.cohort_criteria &&
+          filters == o.filters &&
+          retention_entity == o.retention_entity &&
+          return_condition == o.return_condition &&
+          return_criteria == o.return_criteria &&
+          additional_properties == o.additional_properties
+    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, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/product_analytics_retention_time_interval.rb

@@ -0,0 +1,64 @@
+=begin
+#Datadog API V2 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::V2
+  # A retention interval, either aligned to calendar boundaries or of a fixed length.
+  # Cohort criteria use calendar intervals; return criteria use fixed intervals.
+  module ProductAnalyticsRetentionTimeInterval
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'ProductAnalyticsRetentionCalendarTimeInterval',
+          :'ProductAnalyticsRetentionFixedTimeInterval'
+        ]
+      end
+      # Builds the object
+      # @param data [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            next if typed_data.respond_to?(:_unparsed) && typed_data._unparsed
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
+        end
+      end
+    end
+  end
+end