datadog_api_client 2.52.0 → 2.53.0

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

@@ -0,0 +1,152 @@
+=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 widget request.
+  class ProductAnalyticsFunnelRequest
+    include BaseGenericModel
+
+    # Comparison segments.
+    attr_reader :comparison_segments
+
+    # Comparison time configuration for funnel widgets.
+    attr_accessor :comparison_time
+
+    # User journey funnel query definition.
+    attr_reader :query
+
+    # Request type for user journey funnel widget.
+    attr_reader :request_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'comparison_segments' => :'comparison_segments',
+        :'comparison_time' => :'comparison_time',
+        :'query' => :'query',
+        :'request_type' => :'request_type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'comparison_segments' => :'Array<String>',
+        :'comparison_time' => :'FunnelComparisonDuration',
+        :'query' => :'ProductAnalyticsFunnelQuery',
+        :'request_type' => :'ProductAnalyticsFunnelRequestType'
+      }
+    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::ProductAnalyticsFunnelRequest` 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::ProductAnalyticsFunnelRequest`. 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?(:'comparison_segments')
+        if (value = attributes[:'comparison_segments']).is_a?(Array)
+          self.comparison_segments = value
+        end
+      end
+
+      if attributes.key?(:'comparison_time')
+        self.comparison_time = attributes[:'comparison_time']
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'request_type')
+        self.request_type = attributes[:'request_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 !@comparison_segments.nil? && @comparison_segments.length < 1
+      return false if @query.nil?
+      return false if @request_type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param comparison_segments [Object] Object to be assigned
+    # @!visibility private
+    def comparison_segments=(comparison_segments)
+      if !comparison_segments.nil? && comparison_segments.length < 1
+        fail ArgumentError, 'invalid value for "comparison_segments", number of items must be greater than or equal to 1.'
+      end
+      @comparison_segments = comparison_segments
+    end
+
+    # Custom attribute writer method with validation
+    # @param query [Object] Object to be assigned
+    # @!visibility private
+    def query=(query)
+      if query.nil?
+        fail ArgumentError, 'invalid value for "query", query cannot be nil.'
+      end
+      @query = query
+    end
+
+    # Custom attribute writer method with validation
+    # @param request_type [Object] Object to be assigned
+    # @!visibility private
+    def request_type=(request_type)
+      if request_type.nil?
+        fail ArgumentError, 'invalid value for "request_type", request_type cannot be nil.'
+      end
+      @request_type = request_type
+    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 &&
+          comparison_segments == o.comparison_segments &&
+          comparison_time == o.comparison_time &&
+          query == o.query &&
+          request_type == o.request_type
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [comparison_segments, comparison_time, query, request_type].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/product_analytics_funnel_request_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
+  # Request type for user journey funnel widget.
+  class ProductAnalyticsFunnelRequestType
+    include BaseEnumModel
+
+    USER_JOURNEY_FUNNEL = "user_journey_funnel".freeze
+  end
+end

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

@@ -0,0 +1,185 @@
+=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 user journey funnel visualization displays conversion funnels based on user journey data from Product Analytics.
+  class ProductAnalyticsFunnelWidgetDefinition
+    include BaseGenericModel
+
+    # The description of the widget.
+    attr_accessor :description
+
+    # Display mode for grouped funnel results.
+    attr_accessor :grouped_display
+
+    # Request payload used to query items.
+    attr_reader :requests
+
+    # Time setting for the widget.
+    attr_accessor :time
+
+    # The title of the widget.
+    attr_accessor :title
+
+    # How to align the text on the widget.
+    attr_accessor :title_align
+
+    # The size of the title.
+    attr_accessor :title_size
+
+    # Type of funnel widget.
+    attr_reader :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'grouped_display' => :'grouped_display',
+        :'requests' => :'requests',
+        :'time' => :'time',
+        :'title' => :'title',
+        :'title_align' => :'title_align',
+        :'title_size' => :'title_size',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'description' => :'String',
+        :'grouped_display' => :'FunnelGroupedDisplay',
+        :'requests' => :'Array<ProductAnalyticsFunnelRequest>',
+        :'time' => :'WidgetTime',
+        :'title' => :'String',
+        :'title_align' => :'WidgetTextAlign',
+        :'title_size' => :'String',
+        :'type' => :'FunnelWidgetDefinitionType'
+      }
+    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::ProductAnalyticsFunnelWidgetDefinition` 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::ProductAnalyticsFunnelWidgetDefinition`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'grouped_display')
+        self.grouped_display = attributes[:'grouped_display']
+      end
+
+      if attributes.key?(:'requests')
+        if (value = attributes[:'requests']).is_a?(Array)
+          self.requests = value
+        end
+      end
+
+      if attributes.key?(:'time')
+        self.time = attributes[:'time']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'title_align')
+        self.title_align = attributes[:'title_align']
+      end
+
+      if attributes.key?(:'title_size')
+        self.title_size = attributes[:'title_size']
+      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 @requests.nil?
+      return false if @requests.length < 1
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param requests [Object] Object to be assigned
+    # @!visibility private
+    def requests=(requests)
+      if requests.nil?
+        fail ArgumentError, 'invalid value for "requests", requests cannot be nil.'
+      end
+      if requests.length < 1
+        fail ArgumentError, 'invalid value for "requests", number of items must be greater than or equal to 1.'
+      end
+      @requests = requests
+    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
+
+    # 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 &&
+          description == o.description &&
+          grouped_display == o.grouped_display &&
+          requests == o.requests &&
+          time == o.time &&
+          title == o.title &&
+          title_align == o.title_align &&
+          title_size == o.title_size &&
+          type == o.type
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [description, grouped_display, requests, time, title, title_align, title_size, type].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/retention_cohort_criteria.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
+  # Cohort criteria for retention queries.
+  class RetentionCohortCriteria
+    include BaseGenericModel
+
+    # Product Analytics event query.
+    attr_reader :base_query
+
+    # Time interval for cohort criteria.
+    attr_reader :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' => :'RetentionCohortCriteriaTimeInterval'
+      }
+    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::RetentionCohortCriteria` 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::RetentionCohortCriteria`. 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?
+      return false if @time_interval.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
+
+    # Custom attribute writer method with validation
+    # @param time_interval [Object] Object to be assigned
+    # @!visibility private
+    def time_interval=(time_interval)
+      if time_interval.nil?
+        fail ArgumentError, 'invalid value for "time_interval", time_interval cannot be nil.'
+      end
+      @time_interval = time_interval
+    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_cohort_criteria_time_interval.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
+  # Time interval for cohort criteria.
+  class RetentionCohortCriteriaTimeInterval
+    include BaseGenericModel
+
+    # Type of time interval for cohort criteria.
+    attr_reader :type
+
+    # Calendar interval definition.
+    attr_reader :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'type' => :'RetentionCohortCriteriaTimeIntervalType',
+        :'value' => :'CalendarInterval'
+      }
+    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::RetentionCohortCriteriaTimeInterval` 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::RetentionCohortCriteriaTimeInterval`. 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?(:'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 @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 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 &&
+          value == o.value
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [type, value].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/retention_cohort_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 cohort criteria.
+  class RetentionCohortCriteriaTimeIntervalType
+    include BaseEnumModel
+
+    CALENDAR = "calendar".freeze
+  end
+end