datadog_api_client 2.58.0 → 2.59.1

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

@@ -0,0 +1,209 @@
+=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 single step of the funnel with its conversion counts and timings.
+  class ProductAnalyticsJourneyFunnelStep
+    include BaseGenericModel
+
+    # Elapsed time statistics (min/max/avg in milliseconds).
+    attr_reader :elapsed_time_to_next_step
+
+    # Breakdown of this step by the requested group-by facets.
+    attr_reader :groups
+
+    # Label of the step, derived from the node alias.
+    attr_reader :label
+
+    # Unit of the elapsed time values.
+    attr_reader :unit
+
+    # Value of the computed metric at this step.
+    attr_reader :value
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'elapsed_time_to_next_step' => :'elapsed_time_to_next_step',
+        :'groups' => :'groups',
+        :'label' => :'label',
+        :'unit' => :'unit',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'elapsed_time_to_next_step' => :'ProductAnalyticsElapsedTime',
+        :'groups' => :'Array<ProductAnalyticsJourneyFunnelStepGroup>',
+        :'label' => :'String',
+        :'unit' => :'String',
+        :'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::V2::ProductAnalyticsJourneyFunnelStep` 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?(:'elapsed_time_to_next_step')
+        self.elapsed_time_to_next_step = attributes[:'elapsed_time_to_next_step']
+      end
+
+      if attributes.key?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      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 @elapsed_time_to_next_step.nil?
+      return false if @groups.nil?
+      return false if @label.nil?
+      return false if @unit.nil?
+      return false if @value.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param elapsed_time_to_next_step [Object] Object to be assigned
+    # @!visibility private
+    def elapsed_time_to_next_step=(elapsed_time_to_next_step)
+      if elapsed_time_to_next_step.nil?
+        fail ArgumentError, 'invalid value for "elapsed_time_to_next_step", elapsed_time_to_next_step cannot be nil.'
+      end
+      @elapsed_time_to_next_step = elapsed_time_to_next_step
+    end
+
+    # Custom attribute writer method with validation
+    # @param groups [Object] Object to be assigned
+    # @!visibility private
+    def groups=(groups)
+      if groups.nil?
+        fail ArgumentError, 'invalid value for "groups", groups cannot be nil.'
+      end
+      @groups = groups
+    end
+
+    # Custom attribute writer method with validation
+    # @param label [Object] Object to be assigned
+    # @!visibility private
+    def label=(label)
+      if label.nil?
+        fail ArgumentError, 'invalid value for "label", label cannot be nil.'
+      end
+      @label = label
+    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
+
+    # 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 &&
+          elapsed_time_to_next_step == o.elapsed_time_to_next_step &&
+          groups == o.groups &&
+          label == o.label &&
+          unit == o.unit &&
+          value == o.value &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [elapsed_time_to_next_step, groups, label, unit, value, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+=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
+  # Breakdown of a funnel step for one combination of group-by values.
+  class ProductAnalyticsJourneyFunnelStepGroup
+    include BaseGenericModel
+
+    # Number of entities in this group that reached the next step.
+    attr_reader :conversion_count
+
+    # Elapsed time statistics (min/max/avg in milliseconds).
+    attr_reader :elapsed_time_to_next_step
+
+    # Group-by values identifying this cohort.
+    attr_reader :group_tags
+
+    # Value of the computed metric for this group at this step.
+    attr_reader :value
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'conversion_count' => :'conversion_count',
+        :'elapsed_time_to_next_step' => :'elapsed_time_to_next_step',
+        :'group_tags' => :'group_tags',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'conversion_count' => :'Integer',
+        :'elapsed_time_to_next_step' => :'ProductAnalyticsElapsedTime',
+        :'group_tags' => :'Array<String>',
+        :'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::V2::ProductAnalyticsJourneyFunnelStepGroup` 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?(:'conversion_count')
+        self.conversion_count = attributes[:'conversion_count']
+      end
+
+      if attributes.key?(:'elapsed_time_to_next_step')
+        self.elapsed_time_to_next_step = attributes[:'elapsed_time_to_next_step']
+      end
+
+      if attributes.key?(:'group_tags')
+        if (value = attributes[:'group_tags']).is_a?(Array)
+          self.group_tags = value
+        end
+      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 @conversion_count.nil?
+      return false if @elapsed_time_to_next_step.nil?
+      return false if @group_tags.nil?
+      return false if @value.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param conversion_count [Object] Object to be assigned
+    # @!visibility private
+    def conversion_count=(conversion_count)
+      if conversion_count.nil?
+        fail ArgumentError, 'invalid value for "conversion_count", conversion_count cannot be nil.'
+      end
+      @conversion_count = conversion_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param elapsed_time_to_next_step [Object] Object to be assigned
+    # @!visibility private
+    def elapsed_time_to_next_step=(elapsed_time_to_next_step)
+      if elapsed_time_to_next_step.nil?
+        fail ArgumentError, 'invalid value for "elapsed_time_to_next_step", elapsed_time_to_next_step cannot be nil.'
+      end
+      @elapsed_time_to_next_step = elapsed_time_to_next_step
+    end
+
+    # Custom attribute writer method with validation
+    # @param group_tags [Object] Object to be assigned
+    # @!visibility private
+    def group_tags=(group_tags)
+      if group_tags.nil?
+        fail ArgumentError, 'invalid value for "group_tags", group_tags cannot be nil.'
+      end
+      @group_tags = group_tags
+    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
+
+    # 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 &&
+          conversion_count == o.conversion_count &&
+          elapsed_time_to_next_step == o.elapsed_time_to_next_step &&
+          group_tags == o.group_tags &&
+          value == o.value &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [conversion_count, elapsed_time_to_next_step, group_tags, value, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,223 @@
+=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
+  # Query definition for a journey list request.
+  class ProductAnalyticsJourneyListQuery
+    include BaseGenericModel
+
+    # Computed columns to add to each row.
+    attr_accessor :computed_columns
+
+    # Whether to return the entities that converted at the target step, or those that dropped off.
+    attr_accessor :conversion_type
+
+    # Attribute columns to return for each row, in addition to the identity join key and `timestamp`.
+    attr_accessor :entity_columns
+
+    # Additional search query applied to the returned rows.
+    attr_accessor :entity_filters
+
+    # Segments the results by the values of one or more facets.
+    attr_accessor :group_by
+
+    # Maximum number of rows to return. Omit it to let the service choose.
+    attr_reader :limit
+
+    # Defines the steps of the journey and the filters applied to it.
+    attr_reader :search
+
+    # Sort configuration for the returned rows. The sort is applied only when `facet`
+    # is one of the returned columns; otherwise it is ignored.
+    attr_accessor :sort
+
+    # A reference to a step, or a range of steps, in the journey.
+    # Use a `node` target to name a single step, or a `path` target to name the range
+    # between two steps.
+    attr_accessor :target
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'computed_columns' => :'computed_columns',
+        :'conversion_type' => :'conversion_type',
+        :'entity_columns' => :'entity_columns',
+        :'entity_filters' => :'entity_filters',
+        :'group_by' => :'group_by',
+        :'limit' => :'limit',
+        :'search' => :'search',
+        :'sort' => :'sort',
+        :'target' => :'target'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'computed_columns' => :'Array<ProductAnalyticsJourneyComputedColumn>',
+        :'conversion_type' => :'ProductAnalyticsJourneyConversionType',
+        :'entity_columns' => :'Array<String>',
+        :'entity_filters' => :'String',
+        :'group_by' => :'Array<ProductAnalyticsGraphQueryGroupBy>',
+        :'limit' => :'Integer',
+        :'search' => :'ProductAnalyticsJourneySearch',
+        :'sort' => :'ProductAnalyticsJourneyListSort',
+        :'target' => :'ProductAnalyticsJourneyTarget'
+      }
+    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::ProductAnalyticsJourneyListQuery` 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?(:'computed_columns')
+        if (value = attributes[:'computed_columns']).is_a?(Array)
+          self.computed_columns = value
+        end
+      end
+
+      if attributes.key?(:'conversion_type')
+        self.conversion_type = attributes[:'conversion_type']
+      end
+
+      if attributes.key?(:'entity_columns')
+        if (value = attributes[:'entity_columns']).is_a?(Array)
+          self.entity_columns = value
+        end
+      end
+
+      if attributes.key?(:'entity_filters')
+        self.entity_filters = attributes[:'entity_filters']
+      end
+
+      if attributes.key?(:'group_by')
+        if (value = attributes[:'group_by']).is_a?(Array)
+          self.group_by = value
+        end
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'search')
+        self.search = attributes[:'search']
+      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 !@limit.nil? && @limit < 1
+      return false if @search.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param limit [Object] Object to be assigned
+    # @!visibility private
+    def limit=(limit)
+      if !limit.nil? && limit < 1
+        fail ArgumentError, 'invalid value for "limit", must be greater than or equal to 1.'
+      end
+      @limit = limit
+    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
+
+    # 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 &&
+          computed_columns == o.computed_columns &&
+          conversion_type == o.conversion_type &&
+          entity_columns == o.entity_columns &&
+          entity_filters == o.entity_filters &&
+          group_by == o.group_by &&
+          limit == o.limit &&
+          search == o.search &&
+          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
+      [computed_columns, conversion_type, entity_columns, entity_filters, group_by, limit, search, sort, target, additional_properties].hash
+    end
+  end
+end