datadog_api_client 2.26.1 → 2.28.1

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

@@ -0,0 +1,167 @@
+=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
+  # Object containing IDs of Synthetic tests and a timeframe.
+  class SyntheticsFetchUptimesPayload
+    include BaseGenericModel
+
+    # Timestamp in seconds (Unix epoch) for the start of uptime.
+    attr_reader :from_ts
+
+    # An array of Synthetic test IDs you want to delete.
+    attr_reader :public_ids
+
+    # Timestamp in seconds (Unix epoch) for the end of uptime.
+    attr_reader :to_ts
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'from_ts' => :'from_ts',
+        :'public_ids' => :'public_ids',
+        :'to_ts' => :'to_ts'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'from_ts' => :'Integer',
+        :'public_ids' => :'Array<String>',
+        :'to_ts' => :'Integer'
+      }
+    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::SyntheticsFetchUptimesPayload` 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?(:'from_ts')
+        self.from_ts = attributes[:'from_ts']
+      end
+
+      if attributes.key?(:'public_ids')
+        if (value = attributes[:'public_ids']).is_a?(Array)
+          self.public_ids = value
+        end
+      end
+
+      if attributes.key?(:'to_ts')
+        self.to_ts = attributes[:'to_ts']
+      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 @from_ts.nil?
+      return false if @public_ids.nil?
+      return false if @to_ts.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param from_ts [Object] Object to be assigned
+    # @!visibility private
+    def from_ts=(from_ts)
+      if from_ts.nil?
+        fail ArgumentError, 'invalid value for "from_ts", from_ts cannot be nil.'
+      end
+      @from_ts = from_ts
+    end
+
+    # Custom attribute writer method with validation
+    # @param public_ids [Object] Object to be assigned
+    # @!visibility private
+    def public_ids=(public_ids)
+      if public_ids.nil?
+        fail ArgumentError, 'invalid value for "public_ids", public_ids cannot be nil.'
+      end
+      @public_ids = public_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param to_ts [Object] Object to be assigned
+    # @!visibility private
+    def to_ts=(to_ts)
+      if to_ts.nil?
+        fail ArgumentError, 'invalid value for "to_ts", to_ts cannot be nil.'
+      end
+      @to_ts = to_ts
+    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 &&
+          from_ts == o.from_ts &&
+          public_ids == o.public_ids &&
+          to_ts == o.to_ts
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [from_ts, public_ids, to_ts].hash
+    end
+  end
+end

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

@@ -0,0 +1,229 @@
+=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 steps used in a Synthetic mobile test.
+  class SyntheticsMobileStep
+    include BaseGenericModel
+
+    # A boolean set to allow this step to fail.
+    attr_accessor :allow_failure
+
+    # A boolean set to determine if the step has a new step element.
+    attr_accessor :has_new_step_element
+
+    # A boolean to use in addition to `allowFailure` to determine if the test should be marked as failed when the step fails.
+    attr_accessor :is_critical
+
+    # The name of the step.
+    attr_reader :name
+
+    # A boolean set to not take a screenshot for the step.
+    attr_accessor :no_screenshot
+
+    # The parameters of a mobile step.
+    attr_reader :params
+
+    # The public ID of the step.
+    attr_accessor :public_id
+
+    # The time before declaring a step failed.
+    attr_accessor :timeout
+
+    # Step type used in your mobile Synthetic test.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'allow_failure' => :'allowFailure',
+        :'has_new_step_element' => :'hasNewStepElement',
+        :'is_critical' => :'isCritical',
+        :'name' => :'name',
+        :'no_screenshot' => :'noScreenshot',
+        :'params' => :'params',
+        :'public_id' => :'publicId',
+        :'timeout' => :'timeout',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'allow_failure' => :'Boolean',
+        :'has_new_step_element' => :'Boolean',
+        :'is_critical' => :'Boolean',
+        :'name' => :'String',
+        :'no_screenshot' => :'Boolean',
+        :'params' => :'SyntheticsMobileStepParams',
+        :'public_id' => :'String',
+        :'timeout' => :'Integer',
+        :'type' => :'SyntheticsMobileStepType'
+      }
+    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::SyntheticsMobileStep` 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?(:'allow_failure')
+        self.allow_failure = attributes[:'allow_failure']
+      end
+
+      if attributes.key?(:'has_new_step_element')
+        self.has_new_step_element = attributes[:'has_new_step_element']
+      end
+
+      if attributes.key?(:'is_critical')
+        self.is_critical = attributes[:'is_critical']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'no_screenshot')
+        self.no_screenshot = attributes[:'no_screenshot']
+      end
+
+      if attributes.key?(:'params')
+        self.params = attributes[:'params']
+      end
+
+      if attributes.key?(:'public_id')
+        self.public_id = attributes[:'public_id']
+      end
+
+      if attributes.key?(:'timeout')
+        self.timeout = attributes[:'timeout']
+      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 @name.nil?
+      return false if @name.to_s.length > 1500
+      return false if @params.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param name [Object] Object to be assigned
+    # @!visibility private
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'invalid value for "name", name cannot be nil.'
+      end
+      if name.to_s.length > 1500
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 1500.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param params [Object] Object to be assigned
+    # @!visibility private
+    def params=(params)
+      if params.nil?
+        fail ArgumentError, 'invalid value for "params", params cannot be nil.'
+      end
+      @params = params
+    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 &&
+          allow_failure == o.allow_failure &&
+          has_new_step_element == o.has_new_step_element &&
+          is_critical == o.is_critical &&
+          name == o.name &&
+          no_screenshot == o.no_screenshot &&
+          params == o.params &&
+          public_id == o.public_id &&
+          timeout == o.timeout &&
+          type == o.type
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [allow_failure, has_new_step_element, is_critical, name, no_screenshot, params, public_id, timeout, type].hash
+    end
+  end
+end

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

@@ -0,0 +1,249 @@
+=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 parameters of a mobile step.
+  class SyntheticsMobileStepParams
+    include BaseGenericModel
+
+    # Type of assertion to apply in an API test.
+    attr_accessor :check
+
+    # Number of milliseconds to wait between inputs in a `typeText` step type.
+    attr_reader :delay
+
+    # The direction of the scroll for a `scrollToElement` step type.
+    attr_accessor :direction
+
+    # Information about the element used for a step.
+    attr_accessor :element
+
+    # Boolean to change the state of the wifi for a `toggleWiFi` step type.
+    attr_accessor :enabled
+
+    # Maximum number of scrolls to do for a `scrollToElement` step type.
+    attr_accessor :max_scrolls
+
+    # List of positions for the `flick` step type. The maximum is 10 flicks per step
+    attr_accessor :positions
+
+    # Public ID of the test to be played as part of a `playSubTest` step type.
+    attr_accessor :subtest_public_id
+
+    # Values used in the step for in multiple step types.
+    attr_accessor :value
+
+    # Variable object for `extractVariable` step type.
+    attr_accessor :variable
+
+    # Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.
+    attr_accessor :with_enter
+
+    # Amount to scroll by on the `x` axis for a `scroll` step type.
+    attr_accessor :x
+
+    # Amount to scroll by on the `y` axis for a `scroll` step type.
+    attr_accessor :y
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'check' => :'check',
+        :'delay' => :'delay',
+        :'direction' => :'direction',
+        :'element' => :'element',
+        :'enabled' => :'enabled',
+        :'max_scrolls' => :'maxScrolls',
+        :'positions' => :'positions',
+        :'subtest_public_id' => :'subtestPublicId',
+        :'value' => :'value',
+        :'variable' => :'variable',
+        :'with_enter' => :'withEnter',
+        :'x' => :'x',
+        :'y' => :'y'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'check' => :'SyntheticsCheckType',
+        :'delay' => :'Integer',
+        :'direction' => :'SyntheticsMobileStepParamsDirection',
+        :'element' => :'SyntheticsMobileStepParamsElement',
+        :'enabled' => :'Boolean',
+        :'max_scrolls' => :'Integer',
+        :'positions' => :'Array<SyntheticsMobileStepParamsPositionsItems>',
+        :'subtest_public_id' => :'String',
+        :'value' => :'SyntheticsMobileStepParamsValue',
+        :'variable' => :'SyntheticsMobileStepParamsVariable',
+        :'with_enter' => :'Boolean',
+        :'x' => :'Float',
+        :'y' => :'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::V1::SyntheticsMobileStepParams` 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?(:'check')
+        self.check = attributes[:'check']
+      end
+
+      if attributes.key?(:'delay')
+        self.delay = attributes[:'delay']
+      end
+
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
+      end
+
+      if attributes.key?(:'element')
+        self.element = attributes[:'element']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'max_scrolls')
+        self.max_scrolls = attributes[:'max_scrolls']
+      end
+
+      if attributes.key?(:'positions')
+        if (value = attributes[:'positions']).is_a?(Array)
+          self.positions = value
+        end
+      end
+
+      if attributes.key?(:'subtest_public_id')
+        self.subtest_public_id = attributes[:'subtest_public_id']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'variable')
+        self.variable = attributes[:'variable']
+      end
+
+      if attributes.key?(:'with_enter')
+        self.with_enter = attributes[:'with_enter']
+      end
+
+      if attributes.key?(:'x')
+        self.x = attributes[:'x']
+      end
+
+      if attributes.key?(:'y')
+        self.y = attributes[:'y']
+      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 !@delay.nil? && @delay > 5000
+      return false if !@delay.nil? && @delay < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param delay [Object] Object to be assigned
+    # @!visibility private
+    def delay=(delay)
+      if !delay.nil? && delay > 5000
+        fail ArgumentError, 'invalid value for "delay", must be smaller than or equal to 5000.'
+      end
+      if !delay.nil? && delay < 0
+        fail ArgumentError, 'invalid value for "delay", must be greater than or equal to 0.'
+      end
+      @delay = delay
+    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 &&
+          check == o.check &&
+          delay == o.delay &&
+          direction == o.direction &&
+          element == o.element &&
+          enabled == o.enabled &&
+          max_scrolls == o.max_scrolls &&
+          positions == o.positions &&
+          subtest_public_id == o.subtest_public_id &&
+          value == o.value &&
+          variable == o.variable &&
+          with_enter == o.with_enter &&
+          x == o.x &&
+          y == o.y
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [check, delay, direction, element, enabled, max_scrolls, positions, subtest_public_id, value, variable, with_enter, x, y].hash
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+=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 direction of the scroll for a `scrollToElement` step type.
+  class SyntheticsMobileStepParamsDirection
+    include BaseEnumModel
+
+    UP = "up".freeze
+    DOWN = "down".freeze
+    LEFT = "left".freeze
+    RIGHT = "right".freeze
+  end
+end