kickflow 0.1.0

data/lib/kickflow/models/form_field.rb

@@ -0,0 +1,646 @@
+=begin
+#kickflow REST API v1
+
+#kickflowの開発者用REST API (v1)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.7.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Kickflow
+  # フォームフィールド
+  class FormField
+    # UUID
+    attr_accessor :id
+
+    # 説明文
+    attr_accessor :title
+
+    # 説明文
+    attr_accessor :description
+
+    # フィールドの型
+    attr_accessor :field_type
+
+    # 必須項目かどうか
+    attr_accessor :required
+
+    # 承認者が編集可能かどうか
+    attr_accessor :approver
+
+    # 申請者が編集可能かどうか
+    attr_accessor :author
+
+    # 選択肢のリスト。型がcheckboxまたはpull_downのときのみ値が入ります。
+    attr_accessor :options
+
+    # コード
+    attr_accessor :code
+
+    # フォームサイズ。fullの場合全幅、halfの場合1/2になります。
+    attr_accessor :size
+
+    # 正規表現フォーマット
+    attr_accessor :regexp_format
+
+    # 計算式。 型がcalculationのときのみ値が入ります。
+    attr_accessor :formula
+
+    # 初期値
+    attr_accessor :default_value
+
+    # 最小値
+    attr_accessor :min_value
+
+    # 最大値
+    attr_accessor :max_value
+
+    # 最小文字数
+    attr_accessor :min_length
+
+    # 最大文字数
+    attr_accessor :max_length
+
+    # 小数の桁数
+    attr_accessor :decimal_digit
+
+    # カンマ区切りで表示する場合true。 整数、数値、自動計算フィールド以外ではnullが入ります。
+    attr_accessor :delimited
+
+    # 単位（接頭辞）
+    attr_accessor :prefix
+
+    # 単位（接尾辞）
+    attr_accessor :suffix
+
+    # 隠しフィールドである場合true
+    attr_accessor :hidden
+
+    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
+      {
+        :'id' => :'id',
+        :'title' => :'title',
+        :'description' => :'description',
+        :'field_type' => :'fieldType',
+        :'required' => :'required',
+        :'approver' => :'approver',
+        :'author' => :'author',
+        :'options' => :'options',
+        :'code' => :'code',
+        :'size' => :'size',
+        :'regexp_format' => :'regexpFormat',
+        :'formula' => :'formula',
+        :'default_value' => :'defaultValue',
+        :'min_value' => :'minValue',
+        :'max_value' => :'maxValue',
+        :'min_length' => :'minLength',
+        :'max_length' => :'maxLength',
+        :'decimal_digit' => :'decimalDigit',
+        :'delimited' => :'delimited',
+        :'prefix' => :'prefix',
+        :'suffix' => :'suffix',
+        :'hidden' => :'hidden'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'title' => :'String',
+        :'description' => :'String',
+        :'field_type' => :'String',
+        :'required' => :'Boolean',
+        :'approver' => :'Boolean',
+        :'author' => :'Boolean',
+        :'options' => :'Array<String>',
+        :'code' => :'String',
+        :'size' => :'String',
+        :'regexp_format' => :'String',
+        :'formula' => :'String',
+        :'default_value' => :'String',
+        :'min_value' => :'Float',
+        :'max_value' => :'Float',
+        :'min_length' => :'Float',
+        :'max_length' => :'Float',
+        :'decimal_digit' => :'Integer',
+        :'delimited' => :'Boolean',
+        :'prefix' => :'String',
+        :'suffix' => :'String',
+        :'hidden' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'options',
+        :'regexp_format',
+        :'formula',
+        :'default_value',
+        :'min_value',
+        :'max_value',
+        :'min_length',
+        :'max_length',
+        :'decimal_digit',
+        :'delimited',
+        :'prefix',
+        :'suffix',
+        :'hidden'
+      ])
+    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 `Kickflow::FormField` 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 `Kickflow::FormField`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'field_type')
+        self.field_type = attributes[:'field_type']
+      else
+        self.field_type = nil
+      end
+
+      if attributes.key?(:'required')
+        self.required = attributes[:'required']
+      else
+        self.required = nil
+      end
+
+      if attributes.key?(:'approver')
+        self.approver = attributes[:'approver']
+      else
+        self.approver = nil
+      end
+
+      if attributes.key?(:'author')
+        self.author = attributes[:'author']
+      end
+
+      if attributes.key?(:'options')
+        if (value = attributes[:'options']).is_a?(Array)
+          self.options = value
+        end
+      else
+        self.options = nil
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      else
+        self.code = nil
+      end
+
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      else
+        self.size = nil
+      end
+
+      if attributes.key?(:'regexp_format')
+        self.regexp_format = attributes[:'regexp_format']
+      else
+        self.regexp_format = nil
+      end
+
+      if attributes.key?(:'formula')
+        self.formula = attributes[:'formula']
+      else
+        self.formula = nil
+      end
+
+      if attributes.key?(:'default_value')
+        self.default_value = attributes[:'default_value']
+      else
+        self.default_value = nil
+      end
+
+      if attributes.key?(:'min_value')
+        self.min_value = attributes[:'min_value']
+      else
+        self.min_value = nil
+      end
+
+      if attributes.key?(:'max_value')
+        self.max_value = attributes[:'max_value']
+      else
+        self.max_value = nil
+      end
+
+      if attributes.key?(:'min_length')
+        self.min_length = attributes[:'min_length']
+      else
+        self.min_length = nil
+      end
+
+      if attributes.key?(:'max_length')
+        self.max_length = attributes[:'max_length']
+      else
+        self.max_length = nil
+      end
+
+      if attributes.key?(:'decimal_digit')
+        self.decimal_digit = attributes[:'decimal_digit']
+      else
+        self.decimal_digit = nil
+      end
+
+      if attributes.key?(:'delimited')
+        self.delimited = attributes[:'delimited']
+      else
+        self.delimited = nil
+      end
+
+      if attributes.key?(:'prefix')
+        self.prefix = attributes[:'prefix']
+      else
+        self.prefix = nil
+      end
+
+      if attributes.key?(:'suffix')
+        self.suffix = attributes[:'suffix']
+      else
+        self.suffix = nil
+      end
+
+      if attributes.key?(:'hidden')
+        self.hidden = attributes[:'hidden']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @title.to_s.length > 255
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.')
+      end
+
+      if @field_type.nil?
+        invalid_properties.push('invalid value for "field_type", field_type cannot be nil.')
+      end
+
+      if @required.nil?
+        invalid_properties.push('invalid value for "required", required cannot be nil.')
+      end
+
+      if @approver.nil?
+        invalid_properties.push('invalid value for "approver", approver cannot be nil.')
+      end
+
+      if @code.nil?
+        invalid_properties.push('invalid value for "code", code cannot be nil.')
+      end
+
+      if @code.to_s.length > 255
+        invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 255.')
+      end
+
+      if @size.nil?
+        invalid_properties.push('invalid value for "size", size cannot be nil.')
+      end
+
+      if @min_length < 0
+        invalid_properties.push('invalid value for "min_length", must be greater than or equal to 0.')
+      end
+
+      if @max_length < 0
+        invalid_properties.push('invalid value for "max_length", must be greater than or equal to 0.')
+      end
+
+      if @decimal_digit < 0
+        invalid_properties.push('invalid value for "decimal_digit", 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 @id.nil?
+      return false if @title.nil?
+      return false if @title.to_s.length > 255
+      return false if @field_type.nil?
+      field_type_validator = EnumAttributeValidator.new('String', ["text", "text_long", "number", "integer", "checkbox", "pull_down", "date", "file", "master", "user", "team", "ticket", "calculation", "button_api"])
+      return false unless field_type_validator.valid?(@field_type)
+      return false if @required.nil?
+      return false if @approver.nil?
+      return false if @code.nil?
+      return false if @code.to_s.length > 255
+      return false if @size.nil?
+      size_validator = EnumAttributeValidator.new('String', ["full", "half"])
+      return false unless size_validator.valid?(@size)
+      return false if @min_length < 0
+      return false if @max_length < 0
+      return false if @decimal_digit < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      if title.to_s.length > 255
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.'
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] field_type Object to be assigned
+    def field_type=(field_type)
+      validator = EnumAttributeValidator.new('String', ["text", "text_long", "number", "integer", "checkbox", "pull_down", "date", "file", "master", "user", "team", "ticket", "calculation", "button_api"])
+      unless validator.valid?(field_type)
+        fail ArgumentError, "invalid value for \"field_type\", must be one of #{validator.allowable_values}."
+      end
+      @field_type = field_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] code Value to be assigned
+    def code=(code)
+      if code.nil?
+        fail ArgumentError, 'code cannot be nil'
+      end
+
+      if code.to_s.length > 255
+        fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 255.'
+      end
+
+      @code = code
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] size Object to be assigned
+    def size=(size)
+      validator = EnumAttributeValidator.new('String', ["full", "half"])
+      unless validator.valid?(size)
+        fail ArgumentError, "invalid value for \"size\", must be one of #{validator.allowable_values}."
+      end
+      @size = size
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_length Value to be assigned
+    def min_length=(min_length)
+      if !min_length.nil? && min_length < 0
+        fail ArgumentError, 'invalid value for "min_length", must be greater than or equal to 0.'
+      end
+
+      @min_length = min_length
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_length Value to be assigned
+    def max_length=(max_length)
+      if !max_length.nil? && max_length < 0
+        fail ArgumentError, 'invalid value for "max_length", must be greater than or equal to 0.'
+      end
+
+      @max_length = max_length
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] decimal_digit Value to be assigned
+    def decimal_digit=(decimal_digit)
+      if !decimal_digit.nil? && decimal_digit < 0
+        fail ArgumentError, 'invalid value for "decimal_digit", must be greater than or equal to 0.'
+      end
+
+      @decimal_digit = decimal_digit
+    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 &&
+          id == o.id &&
+          title == o.title &&
+          description == o.description &&
+          field_type == o.field_type &&
+          required == o.required &&
+          approver == o.approver &&
+          author == o.author &&
+          options == o.options &&
+          code == o.code &&
+          size == o.size &&
+          regexp_format == o.regexp_format &&
+          formula == o.formula &&
+          default_value == o.default_value &&
+          min_value == o.min_value &&
+          max_value == o.max_value &&
+          min_length == o.min_length &&
+          max_length == o.max_length &&
+          decimal_digit == o.decimal_digit &&
+          delimited == o.delimited &&
+          prefix == o.prefix &&
+          suffix == o.suffix &&
+          hidden == o.hidden
+    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
+      [id, title, description, field_type, required, approver, author, options, code, size, regexp_format, formula, default_value, min_value, max_value, min_length, max_length, decimal_digit, delimited, prefix, suffix, hidden].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 = Kickflow.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