datadog_api_client 2.26.1 → 2.28.1

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

@@ -0,0 +1,63 @@
+=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
+  # Values used in the step for in multiple step types.
+  module SyntheticsMobileStepParamsValue
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'String',
+          :'Integer'
+        ]
+      end
+      # Builds the object
+      # @param data [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            next if typed_data.respond_to?(:_unparsed) && typed_data._unparsed
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+=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
+  # Variable object for `extractVariable` step type.
+  class SyntheticsMobileStepParamsVariable
+    include BaseGenericModel
+
+    # An example for the variable.
+    attr_reader :example
+
+    # The variable name.
+    attr_reader :name
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'example' => :'example',
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'example' => :'String',
+        :'name' => :'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::SyntheticsMobileStepParamsVariable` 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?(:'example')
+        self.example = attributes[:'example']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      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 @example.nil?
+      return false if @name.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param example [Object] Object to be assigned
+    # @!visibility private
+    def example=(example)
+      if example.nil?
+        fail ArgumentError, 'invalid value for "example", example cannot be nil.'
+      end
+      @example = example
+    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
+      @name = name
+    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 &&
+          example == o.example &&
+          name == o.name
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [example, name].hash
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+=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
+  # Step type used in your mobile Synthetic test.
+  class SyntheticsMobileStepType
+    include BaseEnumModel
+
+    ASSERTELEMENTCONTENT = "assertElementContent".freeze
+    ASSERTSCREENCONTAINS = "assertScreenContains".freeze
+    ASSERTSCREENLACKS = "assertScreenLacks".freeze
+    DOUBLETAP = "doubleTap".freeze
+    EXTRACTVARIABLE = "extractVariable".freeze
+    FLICK = "flick".freeze
+    OPENDEEPLINK = "openDeeplink".freeze
+    PLAYSUBTEST = "playSubTest".freeze
+    PRESSBACK = "pressBack".freeze
+    RESTARTAPPLICATION = "restartApplication".freeze
+    ROTATE = "rotate".freeze
+    SCROLL = "scroll".freeze
+    SCROLLTOELEMENT = "scrollToElement".freeze
+    TAP = "tap".freeze
+    TOGGLEWIFI = "toggleWiFi".freeze
+    TYPETEXT = "typeText".freeze
+    WAIT = "wait".freeze
+  end
+end

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

@@ -0,0 +1,263 @@
+=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 details about a Synthetic mobile test.
+  class SyntheticsMobileTest
+    include BaseGenericModel
+
+    # Configuration object for a Synthetic mobile test.
+    attr_reader :config
+
+    # Array with the different device IDs used to run the test.
+    attr_accessor :device_ids
+
+    # Notification message associated with the test.
+    attr_accessor :message
+
+    # The associated monitor ID.
+    attr_accessor :monitor_id
+
+    # Name of the test.
+    attr_reader :name
+
+    # Object describing the extra options for a Synthetic test.
+    attr_reader :options
+
+    # The public ID of the test.
+    attr_accessor :public_id
+
+    # Define whether you want to start (`live`) or pause (`paused`) a
+    # Synthetic test.
+    attr_accessor :status
+
+    # Array of steps for the test.
+    attr_accessor :steps
+
+    # Array of tags attached to the test.
+    attr_accessor :tags
+
+    # Type of the Synthetic test, `mobile`.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'config' => :'config',
+        :'device_ids' => :'device_ids',
+        :'message' => :'message',
+        :'monitor_id' => :'monitor_id',
+        :'name' => :'name',
+        :'options' => :'options',
+        :'public_id' => :'public_id',
+        :'status' => :'status',
+        :'steps' => :'steps',
+        :'tags' => :'tags',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'config' => :'SyntheticsMobileTestConfig',
+        :'device_ids' => :'Array<String>',
+        :'message' => :'String',
+        :'monitor_id' => :'Integer',
+        :'name' => :'String',
+        :'options' => :'SyntheticsMobileTestOptions',
+        :'public_id' => :'String',
+        :'status' => :'SyntheticsTestPauseStatus',
+        :'steps' => :'Array<SyntheticsMobileStep>',
+        :'tags' => :'Array<String>',
+        :'type' => :'SyntheticsMobileTestType'
+      }
+    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::SyntheticsMobileTest` 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?(:'config')
+        self.config = attributes[:'config']
+      end
+
+      if attributes.key?(:'device_ids')
+        if (value = attributes[:'device_ids']).is_a?(Array)
+          self.device_ids = value
+        end
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'monitor_id')
+        self.monitor_id = attributes[:'monitor_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'options')
+        self.options = attributes[:'options']
+      end
+
+      if attributes.key?(:'public_id')
+        self.public_id = attributes[:'public_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'steps')
+        if (value = attributes[:'steps']).is_a?(Array)
+          self.steps = value
+        end
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      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 @config.nil?
+      return false if @name.nil?
+      return false if @options.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param config [Object] Object to be assigned
+    # @!visibility private
+    def config=(config)
+      if config.nil?
+        fail ArgumentError, 'invalid value for "config", config cannot be nil.'
+      end
+      @config = config
+    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
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param options [Object] Object to be assigned
+    # @!visibility private
+    def options=(options)
+      if options.nil?
+        fail ArgumentError, 'invalid value for "options", options cannot be nil.'
+      end
+      @options = options
+    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 &&
+          config == o.config &&
+          device_ids == o.device_ids &&
+          message == o.message &&
+          monitor_id == o.monitor_id &&
+          name == o.name &&
+          options == o.options &&
+          public_id == o.public_id &&
+          status == o.status &&
+          steps == o.steps &&
+          tags == o.tags &&
+          type == o.type
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [config, device_ids, message, monitor_id, name, options, public_id, status, steps, tags, type].hash
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+=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
+  # Configuration object for a Synthetic mobile test.
+  class SyntheticsMobileTestConfig
+    include BaseGenericModel
+
+    # Initial application arguments for a mobile test.
+    attr_accessor :initial_application_arguments
+
+    # Array of variables used for the test steps.
+    attr_accessor :variables
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'initial_application_arguments' => :'initialApplicationArguments',
+        :'variables' => :'variables'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'initial_application_arguments' => :'Hash<String, String>',
+        :'variables' => :'Array<SyntheticsConfigVariable>'
+      }
+    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::SyntheticsMobileTestConfig` 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?(:'initial_application_arguments')
+        self.initial_application_arguments = attributes[:'initial_application_arguments']
+      end
+
+      if attributes.key?(:'variables')
+        if (value = attributes[:'variables']).is_a?(Array)
+          self.variables = value
+        end
+      end
+    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 &&
+          initial_application_arguments == o.initial_application_arguments &&
+          variables == o.variables
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [initial_application_arguments, variables].hash
+    end
+  end
+end