seatschart 0.2.0 → 0.3.0

data/lib/seatschart/models/post_api_extract_seats_request.rb

@@ -17,16 +17,60 @@ module SeatsChart
   class PostApiExtractSeatsRequest
     attr_accessor :file
 
+    # Calibration JSON (sample patches, rotations, grouping) for the legacy matcher.
     attr_accessor :calibration
 
     attr_accessor :profile
 
+    # `auto` (default): discover the seat glyphs and match them, no clicks needed. `examples`: use the seats clicked in `examples`. `edges`: legacy contour mode tuned by `seat_diameter` and `closing_kernel`.
+    attr_accessor :mode
+
+    attr_accessor :examples
+
+    attr_accessor :negatives
+
+    attr_accessor :region
+
+    # Optional vector source of `file` (a PDF or an SVG, at most 8 MiB): `file` must be that PDF page or SVG rendered whole (any scale; the page box, or the SVG viewBox, maps onto the full image). The scanner reads the drawn geometry (closed paths, rectangles, circles, repeated symbols, text runs) and uses it to check, add and drop seats; a scanned page or one without seat-sized shapes falls back to the image alone (`vector: \"unusable\"`). Works with `auto` and `examples`.
+    attr_accessor :vector
+
+    # PDF page (1-based) that `file` shows; default 1.
+    attr_accessor :vector_page
+
+    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
       {
         :'file' => :'file',
         :'calibration' => :'calibration',
-        :'profile' => :'profile'
+        :'profile' => :'profile',
+        :'mode' => :'mode',
+        :'examples' => :'examples',
+        :'negatives' => :'negatives',
+        :'region' => :'region',
+        :'vector' => :'vector',
+        :'vector_page' => :'vector_page'
       }
     end
 
@@ -40,7 +84,13 @@ module SeatsChart
       {
         :'file' => :'File',
         :'calibration' => :'String',
-        :'profile' => :'String'
+        :'profile' => :'String',
+        :'mode' => :'String',
+        :'examples' => :'PostApiExtractSeatsRequestExamples',
+        :'negatives' => :'PostApiExtractSeatsRequestNegatives',
+        :'region' => :'PostApiExtractSeatsRequestRegion',
+        :'vector' => :'File',
+        :'vector_page' => :'Float'
       }
     end
 
@@ -78,6 +128,30 @@ module SeatsChart
       if attributes.key?(:'profile')
         self.profile = attributes[:'profile']
       end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      end
+
+      if attributes.key?(:'examples')
+        self.examples = attributes[:'examples']
+      end
+
+      if attributes.key?(:'negatives')
+        self.negatives = attributes[:'negatives']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'vector')
+        self.vector = attributes[:'vector']
+      end
+
+      if attributes.key?(:'vector_page')
+        self.vector_page = attributes[:'vector_page']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -98,6 +172,14 @@ module SeatsChart
         invalid_properties.push("invalid value for \"profile\", must conform to the pattern #{pattern}.")
       end
 
+      if !@vector_page.nil? && @vector_page > 2000
+        invalid_properties.push('invalid value for "vector_page", must be smaller than or equal to 2000.')
+      end
+
+      if !@vector_page.nil? && @vector_page < 1
+        invalid_properties.push('invalid value for "vector_page", must be greater than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -108,6 +190,10 @@ module SeatsChart
       return false if @file.nil?
       return false if !@calibration.nil? && @calibration.to_s.length > 16384
       return false if !@profile.nil? && @profile !~ Regexp.new(/^mapa[1-6]$/)
+      mode_validator = EnumAttributeValidator.new('String', ["auto", "examples", "edges"])
+      return false unless mode_validator.valid?(@mode)
+      return false if !@vector_page.nil? && @vector_page > 2000
+      return false if !@vector_page.nil? && @vector_page < 1
       true
     end
 
@@ -140,6 +226,34 @@ module SeatsChart
       @profile = profile
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mode Object to be assigned
+    def mode=(mode)
+      validator = EnumAttributeValidator.new('String', ["auto", "examples", "edges"])
+      unless validator.valid?(mode)
+        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
+      end
+      @mode = mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] vector_page Value to be assigned
+    def vector_page=(vector_page)
+      if vector_page.nil?
+        fail ArgumentError, 'vector_page cannot be nil'
+      end
+
+      if vector_page > 2000
+        fail ArgumentError, 'invalid value for "vector_page", must be smaller than or equal to 2000.'
+      end
+
+      if vector_page < 1
+        fail ArgumentError, 'invalid value for "vector_page", must be greater than or equal to 1.'
+      end
+
+      @vector_page = vector_page
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -147,7 +261,13 @@ module SeatsChart
       self.class == o.class &&
           file == o.file &&
           calibration == o.calibration &&
-          profile == o.profile
+          profile == o.profile &&
+          mode == o.mode &&
+          examples == o.examples &&
+          negatives == o.negatives &&
+          region == o.region &&
+          vector == o.vector &&
+          vector_page == o.vector_page
     end
 
     # @see the `==` method
@@ -159,7 +279,7 @@ module SeatsChart
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [file, calibration, profile].hash
+      [file, calibration, profile, mode, examples, negatives, region, vector, vector_page].hash
     end
 
     # Builds the object from hash

data/lib/seatschart/models/post_api_extract_seats_request_examples.rb

@@ -0,0 +1,105 @@
+=begin
+#SeatsChart API
+
+#Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api-key` (partners) or `Authorization: Bearer` with an HS256 JWT.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SeatsChart
+  # JSON array of 1-24 example seat centres in source-image pixels, e.g. `[{\"x\":412,\"y\":230}]`. Implies `mode=examples`.
+  module PostApiExtractSeatsRequestExamples
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'Array<PostApiExtractSeatsRequestExamplesAnyOfInner>',
+          :'String'
+        ]
+      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)
+        # 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"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_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.parse(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 = SeatsChart.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/seatschart/models/post_api_extract_seats_request_examples_any_of_inner.rb

@@ -0,0 +1,293 @@
+=begin
+#SeatsChart API
+
+#Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api-key` (partners) or `Authorization: Bearer` with an HS256 JWT.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SeatsChart
+  class PostApiExtractSeatsRequestExamplesAnyOfInner
+    attr_accessor :x
+
+    attr_accessor :y
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'x' => :'x',
+        :'y' => :'y'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'x' => :'Float',
+        :'y' => :'Float'
+      }
+    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 `SeatsChart::PostApiExtractSeatsRequestExamplesAnyOfInner` 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 `SeatsChart::PostApiExtractSeatsRequestExamplesAnyOfInner`. 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?(:'x')
+        self.x = attributes[:'x']
+      else
+        self.x = nil
+      end
+
+      if attributes.key?(:'y')
+        self.y = attributes[:'y']
+      else
+        self.y = 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 @x.nil?
+        invalid_properties.push('invalid value for "x", x cannot be nil.')
+      end
+
+      if @x > 16384
+        invalid_properties.push('invalid value for "x", must be smaller than or equal to 16384.')
+      end
+
+      if @x < 0
+        invalid_properties.push('invalid value for "x", must be greater than or equal to 0.')
+      end
+
+      if @y.nil?
+        invalid_properties.push('invalid value for "y", y cannot be nil.')
+      end
+
+      if @y > 16384
+        invalid_properties.push('invalid value for "y", must be smaller than or equal to 16384.')
+      end
+
+      if @y < 0
+        invalid_properties.push('invalid value for "y", must be greater than or equal to 0.')
+      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 @x.nil?
+      return false if @x > 16384
+      return false if @x < 0
+      return false if @y.nil?
+      return false if @y > 16384
+      return false if @y < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] x Value to be assigned
+    def x=(x)
+      if x.nil?
+        fail ArgumentError, 'x cannot be nil'
+      end
+
+      if x > 16384
+        fail ArgumentError, 'invalid value for "x", must be smaller than or equal to 16384.'
+      end
+
+      if x < 0
+        fail ArgumentError, 'invalid value for "x", must be greater than or equal to 0.'
+      end
+
+      @x = x
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] y Value to be assigned
+    def y=(y)
+      if y.nil?
+        fail ArgumentError, 'y cannot be nil'
+      end
+
+      if y > 16384
+        fail ArgumentError, 'invalid value for "y", must be smaller than or equal to 16384.'
+      end
+
+      if y < 0
+        fail ArgumentError, 'invalid value for "y", must be greater than or equal to 0.'
+      end
+
+      @y = y
+    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 &&
+          x == o.x &&
+          y == o.y
+    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
+      [x, y].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)
+      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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 /\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 = SeatsChart.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/seatschart/models/post_api_extract_seats_request_negatives.rb

@@ -0,0 +1,105 @@
+=begin
+#SeatsChart API
+
+#Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api-key` (partners) or `Authorization: Bearer` with an HS256 JWT.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SeatsChart
+  # JSON array of 1-24 wrong detections of an earlier scan (\"not a seat\"), in source-image pixels, e.g. `[{\"x\":96,\"y\":40}]`. Works with `auto` and `examples`: the detection under each point and everything that looks like it are removed; when most of a seat style looks like it, that style is dropped and the plan is rescanned without it.
+  module PostApiExtractSeatsRequestNegatives
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'Array<PostApiExtractSeatsRequestExamplesAnyOfInner>',
+          :'String'
+        ]
+      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)
+        # 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"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_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.parse(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 = SeatsChart.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