datadog_api_client 2.52.0 → 2.53.0

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

@@ -0,0 +1,119 @@
+=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
+  # Compute configuration for user journey funnel.
+  class ProductAnalyticsFunnelCompute
+    include BaseGenericModel
+
+    # Aggregation type for user journey funnel compute.
+    attr_reader :aggregation
+
+    # Metric for user journey funnel compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` (unique users/sessions) and `cardinality` (total users/sessions) as aggregations.
+    attr_reader :metric
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'aggregation' => :'aggregation',
+        :'metric' => :'metric'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'aggregation' => :'ProductAnalyticsFunnelComputeAggregation',
+        :'metric' => :'ProductAnalyticsFunnelComputeMetric'
+      }
+    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::ProductAnalyticsFunnelCompute` 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::ProductAnalyticsFunnelCompute`. 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?(:'aggregation')
+        self.aggregation = attributes[:'aggregation']
+      end
+
+      if attributes.key?(:'metric')
+        self.metric = attributes[:'metric']
+      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 @aggregation.nil?
+      return false if @metric.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param aggregation [Object] Object to be assigned
+    # @!visibility private
+    def aggregation=(aggregation)
+      if aggregation.nil?
+        fail ArgumentError, 'invalid value for "aggregation", aggregation cannot be nil.'
+      end
+      @aggregation = aggregation
+    end
+
+    # Custom attribute writer method with validation
+    # @param metric [Object] Object to be assigned
+    # @!visibility private
+    def metric=(metric)
+      if metric.nil?
+        fail ArgumentError, 'invalid value for "metric", metric cannot be nil.'
+      end
+      @metric = metric
+    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 &&
+          aggregation == o.aggregation &&
+          metric == o.metric
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [aggregation, metric].hash
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+=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
+  # Aggregation type for user journey funnel compute.
+  class ProductAnalyticsFunnelComputeAggregation
+    include BaseEnumModel
+
+    CARDINALITY = "cardinality".freeze
+    COUNT = "count".freeze
+  end
+end

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

@@ -0,0 +1,27 @@
+=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
+  # Metric for user journey funnel compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` (unique users/sessions) and `cardinality` (total users/sessions) as aggregations.
+  class ProductAnalyticsFunnelComputeMetric
+    include BaseEnumModel
+
+    CONVERSION = "__dd.conversion".freeze
+    CONVERSION_RATE = "__dd.conversion_rate".freeze
+  end
+end

data/lib/datadog_api_client/v1/models/product_analytics_funnel_data_source.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
+  # Data source for user journey funnel queries.
+  class ProductAnalyticsFunnelDataSource
+    include BaseEnumModel
+
+    PRODUCT_ANALYTICS_JOURNEY = "product_analytics_journey".freeze
+  end
+end

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

@@ -0,0 +1,163 @@
+=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
+  # Group by configuration for user journey funnel.
+  class ProductAnalyticsFunnelGroupBy
+    include BaseGenericModel
+
+    # Facet to group by.
+    attr_reader :facet
+
+    # Maximum number of groups.
+    attr_accessor :limit
+
+    # Whether to exclude missing values.
+    attr_accessor :should_exclude_missing
+
+    # Sort configuration for user journey funnel group by.
+    attr_accessor :sort
+
+    # Target for user journey search.
+    attr_accessor :target
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'facet' => :'facet',
+        :'limit' => :'limit',
+        :'should_exclude_missing' => :'should_exclude_missing',
+        :'sort' => :'sort',
+        :'target' => :'target'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'facet' => :'String',
+        :'limit' => :'Integer',
+        :'should_exclude_missing' => :'Boolean',
+        :'sort' => :'ProductAnalyticsFunnelGroupBySort',
+        :'target' => :'UserJourneySearchTarget'
+      }
+    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::ProductAnalyticsFunnelGroupBy` 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?(:'facet')
+        self.facet = attributes[:'facet']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'should_exclude_missing')
+        self.should_exclude_missing = attributes[:'should_exclude_missing']
+      end
+
+      if attributes.key?(:'sort')
+        self.sort = attributes[:'sort']
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      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 @facet.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param facet [Object] Object to be assigned
+    # @!visibility private
+    def facet=(facet)
+      if facet.nil?
+        fail ArgumentError, 'invalid value for "facet", facet cannot be nil.'
+      end
+      @facet = facet
+    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 &&
+          facet == o.facet &&
+          limit == o.limit &&
+          should_exclude_missing == o.should_exclude_missing &&
+          sort == o.sort &&
+          target == o.target &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [facet, limit, should_exclude_missing, sort, target, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+=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
+  # Sort configuration for user journey funnel group by.
+  class ProductAnalyticsFunnelGroupBySort
+    include BaseGenericModel
+
+    # Aggregation type.
+    attr_reader :aggregation
+
+    # Metric to sort by.
+    attr_accessor :metric
+
+    # Widget sorting methods.
+    attr_accessor :order
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'aggregation' => :'aggregation',
+        :'metric' => :'metric',
+        :'order' => :'order'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'aggregation' => :'String',
+        :'metric' => :'String',
+        :'order' => :'WidgetSort'
+      }
+    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::ProductAnalyticsFunnelGroupBySort` 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::ProductAnalyticsFunnelGroupBySort`. 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?(:'aggregation')
+        self.aggregation = attributes[:'aggregation']
+      end
+
+      if attributes.key?(:'metric')
+        self.metric = attributes[:'metric']
+      end
+
+      if attributes.key?(:'order')
+        self.order = attributes[:'order']
+      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 @aggregation.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param aggregation [Object] Object to be assigned
+    # @!visibility private
+    def aggregation=(aggregation)
+      if aggregation.nil?
+        fail ArgumentError, 'invalid value for "aggregation", aggregation cannot be nil.'
+      end
+      @aggregation = aggregation
+    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 &&
+          aggregation == o.aggregation &&
+          metric == o.metric &&
+          order == o.order
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [aggregation, metric, order].hash
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+=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
+  # User journey funnel query definition.
+  class ProductAnalyticsFunnelQuery
+    include BaseGenericModel
+
+    # Compute configuration for user journey funnel.
+    attr_accessor :compute
+
+    # Data source for user journey funnel queries.
+    attr_reader :data_source
+
+    # Group by configuration.
+    attr_accessor :group_by
+
+    # User journey search configuration.
+    attr_reader :search
+
+    # Subquery ID.
+    attr_accessor :subquery_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'compute' => :'compute',
+        :'data_source' => :'data_source',
+        :'group_by' => :'group_by',
+        :'search' => :'search',
+        :'subquery_id' => :'subquery_id'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'compute' => :'ProductAnalyticsFunnelCompute',
+        :'data_source' => :'ProductAnalyticsFunnelDataSource',
+        :'group_by' => :'Array<ProductAnalyticsFunnelGroupBy>',
+        :'search' => :'UserJourneySearch',
+        :'subquery_id' => :'String'
+      }
+    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::ProductAnalyticsFunnelQuery` 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::ProductAnalyticsFunnelQuery`. 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?(:'compute')
+        self.compute = attributes[:'compute']
+      end
+
+      if attributes.key?(:'data_source')
+        self.data_source = attributes[:'data_source']
+      end
+
+      if attributes.key?(:'group_by')
+        if (value = attributes[:'group_by']).is_a?(Array)
+          self.group_by = value
+        end
+      end
+
+      if attributes.key?(:'search')
+        self.search = attributes[:'search']
+      end
+
+      if attributes.key?(:'subquery_id')
+        self.subquery_id = attributes[:'subquery_id']
+      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 @data_source.nil?
+      return false if @search.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param data_source [Object] Object to be assigned
+    # @!visibility private
+    def data_source=(data_source)
+      if data_source.nil?
+        fail ArgumentError, 'invalid value for "data_source", data_source cannot be nil.'
+      end
+      @data_source = data_source
+    end
+
+    # Custom attribute writer method with validation
+    # @param search [Object] Object to be assigned
+    # @!visibility private
+    def search=(search)
+      if search.nil?
+        fail ArgumentError, 'invalid value for "search", search cannot be nil.'
+      end
+      @search = search
+    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 &&
+          compute == o.compute &&
+          data_source == o.data_source &&
+          group_by == o.group_by &&
+          search == o.search &&
+          subquery_id == o.subquery_id
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [compute, data_source, group_by, search, subquery_id].hash
+    end
+  end
+end