SematextCloud 0.1.5 → 0.4.0

data/lib/SematextCloud/models/subscription.rb

@@ -0,0 +1,387 @@
+=begin
+#Sematext Cloud API
+
+#API Explorer provides access and documentation for Sematext REST API. The REST API requires the API Key to be sent as part of `Authorization` header. E.g.: `Authorization : apiKey e5f18450-205a-48eb-8589-7d49edaea813`.
+
+OpenAPI spec version: v3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.30
+=end
+
+require 'date'
+
+module SematextCloud
+  class Subscription
+    attr_accessor :additional_params
+
+    attr_accessor :addresses
+
+    attr_accessor :created_by
+
+    attr_accessor :dashboard_id
+
+    attr_accessor :dashboard_name
+
+    attr_accessor :enabled
+
+    attr_accessor :filters
+
+    attr_accessor :frequency
+
+    attr_accessor :id
+
+    attr_accessor :next_send_date
+
+    attr_accessor :subject
+
+    attr_accessor :system_id
+
+    attr_accessor :system_name
+
+    attr_accessor :text
+
+    attr_accessor :time_range
+
+    attr_accessor :user_permissions
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'additional_params' => :'additionalParams',
+        :'addresses' => :'addresses',
+        :'created_by' => :'createdBy',
+        :'dashboard_id' => :'dashboardId',
+        :'dashboard_name' => :'dashboardName',
+        :'enabled' => :'enabled',
+        :'filters' => :'filters',
+        :'frequency' => :'frequency',
+        :'id' => :'id',
+        :'next_send_date' => :'nextSendDate',
+        :'subject' => :'subject',
+        :'system_id' => :'systemId',
+        :'system_name' => :'systemName',
+        :'text' => :'text',
+        :'time_range' => :'timeRange',
+        :'user_permissions' => :'userPermissions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'additional_params' => :'Object',
+        :'addresses' => :'Object',
+        :'created_by' => :'Object',
+        :'dashboard_id' => :'Object',
+        :'dashboard_name' => :'Object',
+        :'enabled' => :'Object',
+        :'filters' => :'Object',
+        :'frequency' => :'Object',
+        :'id' => :'Object',
+        :'next_send_date' => :'Object',
+        :'subject' => :'Object',
+        :'system_id' => :'Object',
+        :'system_name' => :'Object',
+        :'text' => :'Object',
+        :'time_range' => :'Object',
+        :'user_permissions' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+  
+    # Initializes the object
+    # @param [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 `SematextCloud::Subscription` 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 `SematextCloud::Subscription`. 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?(:'additional_params')
+        self.additional_params = attributes[:'additional_params']
+      end
+
+      if attributes.key?(:'addresses')
+        self.addresses = attributes[:'addresses']
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      end
+
+      if attributes.key?(:'dashboard_id')
+        self.dashboard_id = attributes[:'dashboard_id']
+      end
+
+      if attributes.key?(:'dashboard_name')
+        self.dashboard_name = attributes[:'dashboard_name']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'filters')
+        self.filters = attributes[:'filters']
+      end
+
+      if attributes.key?(:'frequency')
+        self.frequency = attributes[:'frequency']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'next_send_date')
+        self.next_send_date = attributes[:'next_send_date']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'system_id')
+        self.system_id = attributes[:'system_id']
+      end
+
+      if attributes.key?(:'system_name')
+        self.system_name = attributes[:'system_name']
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'time_range')
+        self.time_range = attributes[:'time_range']
+      end
+
+      if attributes.key?(:'user_permissions')
+        self.user_permissions = attributes[:'user_permissions']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      frequency_validator = EnumAttributeValidator.new('Object', ['EVERY_FIVE_MINUTES', 'DAILY', 'WEEKLY', 'MONTHLY', 'QUARTERLY'])
+      return false unless frequency_validator.valid?(@frequency)
+      time_range_validator = EnumAttributeValidator.new('Object', ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'TWO_MONTH', 'SIX_MONTH', 'ONE_YEAR'])
+      return false unless time_range_validator.valid?(@time_range)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] frequency Object to be assigned
+    def frequency=(frequency)
+      validator = EnumAttributeValidator.new('Object', ['EVERY_FIVE_MINUTES', 'DAILY', 'WEEKLY', 'MONTHLY', 'QUARTERLY'])
+      unless validator.valid?(frequency)
+        fail ArgumentError, "invalid value for \"frequency\", must be one of #{validator.allowable_values}."
+      end
+      @frequency = frequency
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] time_range Object to be assigned
+    def time_range=(time_range)
+      validator = EnumAttributeValidator.new('Object', ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'TWO_MONTH', 'SIX_MONTH', 'ONE_YEAR'])
+      unless validator.valid?(time_range)
+        fail ArgumentError, "invalid value for \"time_range\", must be one of #{validator.allowable_values}."
+      end
+      @time_range = time_range
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          additional_params == o.additional_params &&
+          addresses == o.addresses &&
+          created_by == o.created_by &&
+          dashboard_id == o.dashboard_id &&
+          dashboard_name == o.dashboard_name &&
+          enabled == o.enabled &&
+          filters == o.filters &&
+          frequency == o.frequency &&
+          id == o.id &&
+          next_send_date == o.next_send_date &&
+          subject == o.subject &&
+          system_id == o.system_id &&
+          system_name == o.system_name &&
+          text == o.text &&
+          time_range == o.time_range &&
+          user_permissions == o.user_permissions
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [additional_params, addresses, created_by, dashboard_id, dashboard_name, enabled, filters, frequency, id, next_send_date, subject, system_id, system_name, text, time_range, user_permissions].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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 /\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
+        SematextCloud.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    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
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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 [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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

data/lib/SematextCloud/models/subscription_dashboard_dto.rb

@@ -6,13 +6,12 @@
 OpenAPI spec version: v3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.12
-
+Swagger Codegen version: 3.0.30
 =end
 
 require 'date'
 
-module stcloud
+module SematextCloud
   class SubscriptionDashboardDto
     attr_accessor :addresses
 
@@ -76,72 +75,85 @@ module stcloud
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
-        :'addresses' => :'String',
-        :'dashboard_id' => :'Integer',
-        :'enable' => :'BOOLEAN',
-        :'filters' => :'String',
-        :'frequency' => :'String',
-        :'id' => :'Integer',
-        :'report_name' => :'String',
-        :'send_time' => :'DateTime',
-        :'subject' => :'String',
-        :'text' => :'String',
-        :'time_range' => :'String'
+        :'addresses' => :'Object',
+        :'dashboard_id' => :'Object',
+        :'enable' => :'Object',
+        :'filters' => :'Object',
+        :'frequency' => :'Object',
+        :'id' => :'Object',
+        :'report_name' => :'Object',
+        :'send_time' => :'Object',
+        :'subject' => :'Object',
+        :'text' => :'Object',
+        :'time_range' => :'Object'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+  
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SematextCloud::SubscriptionDashboardDto` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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 `SematextCloud::SubscriptionDashboardDto`. 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.has_key?(:'addresses')
+      if attributes.key?(:'addresses')
         self.addresses = attributes[:'addresses']
       end
 
-      if attributes.has_key?(:'dashboardId')
-        self.dashboard_id = attributes[:'dashboardId']
+      if attributes.key?(:'dashboard_id')
+        self.dashboard_id = attributes[:'dashboard_id']
       end
 
-      if attributes.has_key?(:'enable')
+      if attributes.key?(:'enable')
         self.enable = attributes[:'enable']
       end
 
-      if attributes.has_key?(:'filters')
+      if attributes.key?(:'filters')
         self.filters = attributes[:'filters']
       end
 
-      if attributes.has_key?(:'frequency')
+      if attributes.key?(:'frequency')
         self.frequency = attributes[:'frequency']
       end
 
-      if attributes.has_key?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'reportName')
-        self.report_name = attributes[:'reportName']
+      if attributes.key?(:'report_name')
+        self.report_name = attributes[:'report_name']
       end
 
-      if attributes.has_key?(:'sendTime')
-        self.send_time = attributes[:'sendTime']
+      if attributes.key?(:'send_time')
+        self.send_time = attributes[:'send_time']
       end
 
-      if attributes.has_key?(:'subject')
+      if attributes.key?(:'subject')
         self.subject = attributes[:'subject']
       end
 
-      if attributes.has_key?(:'text')
+      if attributes.key?(:'text')
         self.text = attributes[:'text']
       end
 
-      if attributes.has_key?(:'timeRange')
-        self.time_range = attributes[:'timeRange']
+      if attributes.key?(:'time_range')
+        self.time_range = attributes[:'time_range']
       end
     end
 
@@ -155,9 +167,9 @@ module stcloud
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      frequency_validator = EnumAttributeValidator.new('String', ['EVERY_FIVE_MINUTES', 'DAILY', 'WEEKLY', 'MONTHLY', 'QUARTERLY'])
+      frequency_validator = EnumAttributeValidator.new('Object', ['EVERY_FIVE_MINUTES', 'DAILY', 'WEEKLY', 'MONTHLY', 'QUARTERLY'])
       return false unless frequency_validator.valid?(@frequency)
-      time_range_validator = EnumAttributeValidator.new('String', ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'TWO_MONTH', 'SIX_MONTH', 'ONE_YEAR'])
+      time_range_validator = EnumAttributeValidator.new('Object', ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'TWO_MONTH', 'SIX_MONTH', 'ONE_YEAR'])
       return false unless time_range_validator.valid?(@time_range)
       true
     end
@@ -165,9 +177,9 @@ module stcloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] frequency Object to be assigned
     def frequency=(frequency)
-      validator = EnumAttributeValidator.new('String', ['EVERY_FIVE_MINUTES', 'DAILY', 'WEEKLY', 'MONTHLY', 'QUARTERLY'])
+      validator = EnumAttributeValidator.new('Object', ['EVERY_FIVE_MINUTES', 'DAILY', 'WEEKLY', 'MONTHLY', 'QUARTERLY'])
       unless validator.valid?(frequency)
-        fail ArgumentError, 'invalid value for "frequency", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"frequency\", must be one of #{validator.allowable_values}."
       end
       @frequency = frequency
     end
@@ -175,9 +187,9 @@ module stcloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] time_range Object to be assigned
     def time_range=(time_range)
-      validator = EnumAttributeValidator.new('String', ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'TWO_MONTH', 'SIX_MONTH', 'ONE_YEAR'])
+      validator = EnumAttributeValidator.new('Object', ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'TWO_MONTH', 'SIX_MONTH', 'ONE_YEAR'])
       unless validator.valid?(time_range)
-        fail ArgumentError, 'invalid value for "time_range", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"time_range\", must be one of #{validator.allowable_values}."
       end
       @time_range = time_range
     end
@@ -207,26 +219,35 @@ module stcloud
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [addresses, dashboard_id, enable, filters, frequency, id, report_name, send_time, subject, text, time_range].hash
     end
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
+      self.class.openapi_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
       end
 
       self
@@ -248,7 +269,7 @@ module stcloud
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -269,8 +290,7 @@ module stcloud
           end
         end
       else # model
-        temp_model = stcloud.const_get(type).new
-        temp_model.build_from_hash(value)
+        SematextCloud.const_get(type).build_from_hash(value)
       end
     end
 
@@ -292,7 +312,11 @@ module stcloud
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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
@@ -314,6 +338,5 @@ module stcloud
       else
         value
       end
-    end
-  end
+    end  end
 end