plainrouter-sdk 0.2.0 → 0.6.0

data/lib/plainrouter/openapi/models/actions_rules_update_request.rb

@@ -0,0 +1,267 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  # All fields are optional. platform_ad_account_id must be absent. window, window_days, author_type and current_revision_id must be absent or empty.
+  class ActionsRulesUpdateRequest < ApiModelBase
+    attr_accessor :name
+
+    attr_accessor :definition
+
+    # Optional integer account ID. JSON booleans return 422 with message plus field errors. A valid supplied ID is ignored by an account-bound key. An unbound key requires exactly one active available advertising account with an active connection; omission uses that account and a supplied ID must match it. Multiple active accounts return 422 even when account_id is supplied.
+    attr_accessor :account_id
+
+    attr_accessor :enabled
+
+    attr_accessor :window
+
+    attr_accessor :window_days
+
+    attr_accessor :author_type
+
+    attr_accessor :current_revision_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'definition' => :'definition',
+        :'account_id' => :'account_id',
+        :'enabled' => :'enabled',
+        :'window' => :'window',
+        :'window_days' => :'window_days',
+        :'author_type' => :'author_type',
+        :'current_revision_id' => :'current_revision_id'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'definition' => :'ActionsRulesUpdateRequestDefinition',
+        :'account_id' => :'Integer',
+        :'enabled' => :'Boolean',
+        :'window' => :'ActionsRulesStoreRequestWindow',
+        :'window_days' => :'ActionsRulesStoreRequestWindow',
+        :'author_type' => :'ActionsRulesStoreRequestWindow',
+        :'current_revision_id' => :'ActionsRulesStoreRequestWindow'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'window',
+        :'window_days',
+        :'author_type',
+        :'current_revision_id'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      ClosedInputValidator.validate_model!(self, attributes)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PlainRouter::OpenAPI::ActionsRulesUpdateRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PlainRouter::OpenAPI::ActionsRulesUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'definition')
+        self.definition = attributes[:'definition']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'window')
+        self.window = attributes[:'window']
+      end
+
+      if attributes.key?(:'window_days')
+        self.window_days = attributes[:'window_days']
+      end
+
+      if attributes.key?(:'author_type')
+        self.author_type = attributes[:'author_type']
+      end
+
+      if attributes.key?(:'current_revision_id')
+        self.current_revision_id = attributes[:'current_revision_id']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@name.nil? && @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      pattern = Regexp.new(/\S/)
+      if !@name.nil? && @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@account_id.nil? && @account_id < 1
+        invalid_properties.push('invalid value for "account_id", must be greater than or equal to 1.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@name.nil? && @name.to_s.length > 255
+      return false if !@name.nil? && @name !~ Regexp.new(/\S/)
+      return false if !@account_id.nil? && @account_id < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      pattern = Regexp.new(/\S/)
+      if name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_id Value to be assigned
+    def account_id=(account_id)
+      if account_id.nil?
+        fail ArgumentError, 'account_id cannot be nil'
+      end
+
+      if account_id < 1
+        fail ArgumentError, 'invalid value for "account_id", must be greater than or equal to 1.'
+      end
+
+      @account_id = account_id
+    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 &&
+          name == o.name &&
+          definition == o.definition &&
+          account_id == o.account_id &&
+          enabled == o.enabled &&
+          window == o.window &&
+          window_days == o.window_days &&
+          author_type == o.author_type &&
+          current_revision_id == o.current_revision_id
+    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
+      [name, definition, account_id, enabled, window, window_days, author_type, current_revision_id].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)
+      ClosedInputValidator.validate_model!(self, attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end

data/lib/plainrouter/openapi/models/actions_rules_update_request_definition.rb

@@ -0,0 +1,105 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  module ActionsRulesUpdateRequestDefinition
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'ActionsRulesUpdateRequestDefinitionAnyOf',
+          :'ActionsRulesUpdateRequestDefinitionAnyOf1',
+          :'ActionsRulesUpdateRequestDefinitionAnyOf2'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        ClosedInputValidator.validate_model!(self, data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - 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_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = PlainRouter::OpenAPI.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/plainrouter/openapi/models/actions_rules_update_request_definition_any_of.rb

@@ -0,0 +1,317 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  # Only target_level, action, budget_change_percent, minimum_counted_arrivals, cost_comparison and cost_ratio are accepted.
+  class ActionsRulesUpdateRequestDefinitionAnyOf < ApiModelBase
+    attr_accessor :target_level
+
+    attr_accessor :action
+
+    attr_accessor :minimum_counted_arrivals
+
+    attr_accessor :cost_comparison
+
+    attr_accessor :cost_ratio
+
+    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
+      {
+        :'target_level' => :'target_level',
+        :'action' => :'action',
+        :'minimum_counted_arrivals' => :'minimum_counted_arrivals',
+        :'cost_comparison' => :'cost_comparison',
+        :'cost_ratio' => :'cost_ratio'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'target_level' => :'String',
+        :'action' => :'String',
+        :'minimum_counted_arrivals' => :'Integer',
+        :'cost_comparison' => :'String',
+        :'cost_ratio' => :'ActionsRulesStoreRequestDefinitionAnyOfCostRatio'
+      }
+    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 = {})
+      ClosedInputValidator.validate_model!(self, attributes)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PlainRouter::OpenAPI::ActionsRulesUpdateRequestDefinitionAnyOf` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PlainRouter::OpenAPI::ActionsRulesUpdateRequestDefinitionAnyOf`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'target_level')
+        self.target_level = attributes[:'target_level']
+      else
+        self.target_level = nil
+      end
+
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
+      else
+        self.action = nil
+      end
+
+      if attributes.key?(:'minimum_counted_arrivals')
+        self.minimum_counted_arrivals = attributes[:'minimum_counted_arrivals']
+      else
+        self.minimum_counted_arrivals = nil
+      end
+
+      if attributes.key?(:'cost_comparison')
+        self.cost_comparison = attributes[:'cost_comparison']
+      else
+        self.cost_comparison = nil
+      end
+
+      if attributes.key?(:'cost_ratio')
+        self.cost_ratio = attributes[:'cost_ratio']
+      else
+        self.cost_ratio = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @target_level.nil?
+        invalid_properties.push('invalid value for "target_level", target_level cannot be nil.')
+      end
+
+      if @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @minimum_counted_arrivals.nil?
+        invalid_properties.push('invalid value for "minimum_counted_arrivals", minimum_counted_arrivals cannot be nil.')
+      end
+
+      if @minimum_counted_arrivals > 9223372036854776000
+        invalid_properties.push('invalid value for "minimum_counted_arrivals", must be smaller than or equal to 9223372036854776000.')
+      end
+
+      if @minimum_counted_arrivals < 50
+        invalid_properties.push('invalid value for "minimum_counted_arrivals", must be greater than or equal to 50.')
+      end
+
+      if @cost_comparison.nil?
+        invalid_properties.push('invalid value for "cost_comparison", cost_comparison cannot be nil.')
+      end
+
+      if @cost_ratio.nil?
+        invalid_properties.push('invalid value for "cost_ratio", cost_ratio 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
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @target_level.nil?
+      target_level_validator = EnumAttributeValidator.new('String', ["ad", "ad_set"])
+      return false unless target_level_validator.valid?(@target_level)
+      return false if @action.nil?
+      action_validator = EnumAttributeValidator.new('String', ["pause"])
+      return false unless action_validator.valid?(@action)
+      return false if @minimum_counted_arrivals.nil?
+      return false if @minimum_counted_arrivals > 9223372036854776000
+      return false if @minimum_counted_arrivals < 50
+      return false if @cost_comparison.nil?
+      cost_comparison_validator = EnumAttributeValidator.new('String', ["at_least", "at_most"])
+      return false unless cost_comparison_validator.valid?(@cost_comparison)
+      return false if @cost_ratio.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] target_level Object to be assigned
+    def target_level=(target_level)
+      validator = EnumAttributeValidator.new('String', ["ad", "ad_set"])
+      unless validator.valid?(target_level)
+        fail ArgumentError, "invalid value for \"target_level\", must be one of #{validator.allowable_values}."
+      end
+      @target_level = target_level
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action Object to be assigned
+    def action=(action)
+      validator = EnumAttributeValidator.new('String', ["pause"])
+      unless validator.valid?(action)
+        fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
+      end
+      @action = action
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] minimum_counted_arrivals Value to be assigned
+    def minimum_counted_arrivals=(minimum_counted_arrivals)
+      if minimum_counted_arrivals.nil?
+        fail ArgumentError, 'minimum_counted_arrivals cannot be nil'
+      end
+
+      if minimum_counted_arrivals > 9223372036854776000
+        fail ArgumentError, 'invalid value for "minimum_counted_arrivals", must be smaller than or equal to 9223372036854776000.'
+      end
+
+      if minimum_counted_arrivals < 50
+        fail ArgumentError, 'invalid value for "minimum_counted_arrivals", must be greater than or equal to 50.'
+      end
+
+      @minimum_counted_arrivals = minimum_counted_arrivals
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] cost_comparison Object to be assigned
+    def cost_comparison=(cost_comparison)
+      validator = EnumAttributeValidator.new('String', ["at_least", "at_most"])
+      unless validator.valid?(cost_comparison)
+        fail ArgumentError, "invalid value for \"cost_comparison\", must be one of #{validator.allowable_values}."
+      end
+      @cost_comparison = cost_comparison
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cost_ratio Value to be assigned
+    def cost_ratio=(cost_ratio)
+      if cost_ratio.nil?
+        fail ArgumentError, 'cost_ratio cannot be nil'
+      end
+
+      @cost_ratio = cost_ratio
+    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 &&
+          target_level == o.target_level &&
+          action == o.action &&
+          minimum_counted_arrivals == o.minimum_counted_arrivals &&
+          cost_comparison == o.cost_comparison &&
+          cost_ratio == o.cost_ratio
+    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
+      [target_level, action, minimum_counted_arrivals, cost_comparison, cost_ratio].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)
+      ClosedInputValidator.validate_model!(self, attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end