Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix funnel steps definition #734

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.2",
"regenerated": "2022-02-11 17:09:50.110712",
"spec_repo_commit": "f8964dd"
"regenerated": "2022-02-14 18:03:11.135394",
"spec_repo_commit": "e72d1cd"
},
"v2": {
"apigentools_version": "1.6.2",
"regenerated": "2022-02-11 17:09:50.129565",
"spec_repo_commit": "f8964dd"
"regenerated": "2022-02-14 18:03:11.156486",
"spec_repo_commit": "e72d1cd"
}
}
}
38 changes: 19 additions & 19 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2563,7 +2563,10 @@ components:
example: '@browser.name:Chrome'
type: string
steps:
$ref: '#/components/schemas/FunnelSteps'
description: List of funnel steps.
items:
$ref: '#/components/schemas/FunnelStep'
type: array
required:
- query_string
- data_source
Expand All @@ -2586,24 +2589,21 @@ components:
type: string
x-enum-varnames:
- RUM
FunnelSteps:
description: List of funnel steps.
items:
description: The funnel step.
properties:
facet:
description: The facet of the step.
example: '@view.name'
type: string
value:
description: The value of the step.
example: /apm/home
type: string
required:
- facet
- value
type: object
type: array
FunnelStep:
description: The funnel step.
properties:
facet:
description: The facet of the step.
example: '@view.name'
type: string
value:
description: The value of the step.
example: /apm/home
type: string
required:
- facet
- value
type: object
FunnelWidgetDefinition:
description: 'The funnel visualization displays a funnel of user sessions that
maps a sequence of view navigation and user interaction in your application.
Expand Down
1 change: 1 addition & 0 deletions lib/datadog_api_client/v1.rb
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@
require 'datadog_api_client/v1/models/funnel_query'
require 'datadog_api_client/v1/models/funnel_request_type'
require 'datadog_api_client/v1/models/funnel_source'
require 'datadog_api_client/v1/models/funnel_step'
require 'datadog_api_client/v1/models/funnel_widget_definition'
require 'datadog_api_client/v1/models/funnel_widget_definition_type'
require 'datadog_api_client/v1/models/funnel_widget_request'
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/funnel_query.rb
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def self.openapi_types
{
:'data_source' => :'FunnelSource',
:'query_string' => :'String',
:'steps' => :'Array<Object>'
:'steps' => :'Array<FunnelStep>'
}
end

Expand Down
270 changes: 270 additions & 0 deletions lib/datadog_api_client/v1/models/funnel_step.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,270 @@
=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://openapi-generator.tech

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 funnel step.
class FunnelStep
# Whether the object has unparsed attributes
# @!visibility private
attr_accessor :_unparsed

# The facet of the step.
attr_accessor :facet

# The value of the step.
attr_accessor :value

# Attribute mapping from ruby-style variable name to JSON key.
# @!visibility private
def self.attribute_map
{
:'facet' => :'facet',
:'value' => :'value'
}
end

# Returns all the JSON keys this model knows about
# @!visibility private
def self.acceptable_attributes
attribute_map.values
end

# Attribute type mapping.
# @!visibility private
def self.openapi_types
{
:'facet' => :'String',
:'value' => :'String'
}
end

# List of attributes with nullable: true
# @!visibility private
def self.openapi_nullable
Set.new([
])
end

# Initializes the object
# @param attributes [Hash] attributes Model attributes in the form of hash
def initialize(attributes = {})
if (!attributes.is_a?(Hash))
fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::FunnelStep` 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::FunnelStep`. 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?(:'facet')
self.facet = attributes[:'facet']
end

if attributes.key?(:'value')
self.value = attributes[:'value']
end
end

# Show invalid properties with the reasons. Usually used together with valid?
# @!visibility private
# @return Array for valid properties with the reasons
def list_invalid_properties
invalid_properties = Array.new
if @facet.nil?
invalid_properties.push('invalid value for "facet", facet cannot be nil.')
end

if @value.nil?
invalid_properties.push('invalid value for "value", value cannot be nil.')
end

invalid_properties
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?
return false if @value.nil?
true
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 &&
value == o.value
end

# @see the `==` method
# @param o [Object] Object to be compared
# @!visibility private
def eql?(o)
self == o
end

# Calculates hash code according to all attributes.
# @return [Integer] Hash code
# @!visibility private
def hash
[facet, value].hash
end

# Builds the object from hash
# @param attributes [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
# @!visibility private
def self.build_from_hash(attributes)
new.build_from_hash(attributes)
end

# Builds the object from hash
# @param attributes [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
# @!visibility private
def build_from_hash(attributes)
return nil unless attributes.is_a?(Hash)
self.class.openapi_types.each_pair do |key, type|
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
self.send("#{key}=", nil)
elsif type =~ /\AArray<(.*)>/i
# check to ensure the input is an array given that the attribute
# is documented as an array but the input is not
if attributes[self.class.attribute_map[key]].is_a?(Array)
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
end
elsif !attributes[self.class.attribute_map[key]].nil?
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
end
end

self
end

# Deserializes the data based on type
# @param type [string] Data type
# @param value [string] Value to be deserialized
# @return [Object] Deserialized data
# @!visibility private
def _deserialize(type, value)
case type.to_sym
when :Time
Time.parse(value)
when :Date
Date.parse(value)
when :String
value.to_s
when :Integer
value.to_i
when :Float
value.to_f
when :Boolean
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
true
else
false
end
when :Object
# generic object (usually a Hash), return directly
value
when :Array
# generic array, return directly
value
when /\AArray<(?<inner_type>.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
k_type = Regexp.last_match[:k_type]
v_type = Regexp.last_match[:v_type]
{}.tap do |hash|
value.each do |k, v|
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
end
end
else # model
# models (e.g. Pet) or oneOf
klass = DatadogAPIClient::V1.const_get(type)
res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
if res.instance_of? DatadogAPIClient::V1::UnparsedObject
self._unparsed = true
end
res
end
end

# Returns the string representation of the object
# @return [String] String presentation of the object
# @!visibility private
def to_s
to_hash.to_s
end

# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
# @!visibility private
def to_body
to_hash
end

# Returns the object in the form of hash
# @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
hash
end

# Outputs non-array value in the form of hash
# For object, use to_hash. Otherwise, just return the value
# @param value [Object] value Any valid value
# @return [Hash] Returns the value in the form of hash
# @!visibility private
def _to_hash(value)
if value.is_a?(Array)
value.compact.map { |v| _to_hash(v) }
elsif value.is_a?(Hash)
{}.tap do |hash|
value.each { |k, v| hash[k] = _to_hash(v) }
end
elsif value.respond_to? :to_hash
value.to_hash
else
value
end
end

end

end