kickflow 0.1.0

data/lib/kickflow/models/route_step.rb

@@ -0,0 +1,495 @@
+=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 RouteStep
+    # UUID
+    attr_accessor :id
+
+    # ステップ順序（1から始まります）
+    attr_accessor :step_order
+
+    # ステップのタイプ
+    attr_accessor :step_type
+
+    # タイトル
+    attr_accessor :title
+
+    # アクションタイプ。承認/差し戻しの場合approve、回覧（確認あり）の場合confirm、回覧（確認なし）の場合noneになります。
+    attr_accessor :action_type
+
+    # 承認者への指示
+    attr_accessor :instruction
+
+    # 必要な承認人数
+    attr_accessor :required_approvals_number
+
+    # 必要な承認割合（%）
+    attr_accessor :required_approvals_percent
+
+    # フォールバックのタイプ
+    attr_accessor :fallback_type
+
+    # 自己承認を許可するか
+    attr_accessor :allow_self_approval
+
+    # 最小指名人数。「申請者が指名」ステップのみ設定可能。
+    attr_accessor :min_custom_assignees
+
+    # 承認者の指定に使うユーザーの配列
+    attr_accessor :users
+
+    # 承認者の指定に使うチームと役職の条件
+    attr_accessor :targets
+
+    attr_accessor :route_step_condition
+
+    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',
+        :'step_order' => :'stepOrder',
+        :'step_type' => :'stepType',
+        :'title' => :'title',
+        :'action_type' => :'actionType',
+        :'instruction' => :'instruction',
+        :'required_approvals_number' => :'requiredApprovalsNumber',
+        :'required_approvals_percent' => :'requiredApprovalsPercent',
+        :'fallback_type' => :'fallbackType',
+        :'allow_self_approval' => :'allowSelfApproval',
+        :'min_custom_assignees' => :'minCustomAssignees',
+        :'users' => :'users',
+        :'targets' => :'targets',
+        :'route_step_condition' => :'routeStepCondition'
+      }
+    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',
+        :'step_order' => :'Integer',
+        :'step_type' => :'String',
+        :'title' => :'String',
+        :'action_type' => :'String',
+        :'instruction' => :'String',
+        :'required_approvals_number' => :'Integer',
+        :'required_approvals_percent' => :'Integer',
+        :'fallback_type' => :'String',
+        :'allow_self_approval' => :'Boolean',
+        :'min_custom_assignees' => :'Integer',
+        :'users' => :'Array<User>',
+        :'targets' => :'Array<RouteStepTarget>',
+        :'route_step_condition' => :'RouteStepCondition'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'instruction',
+        :'fallback_type',
+        :'min_custom_assignees',
+        :'route_step_condition'
+      ])
+    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::RouteStep` 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::RouteStep`. 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?(:'step_order')
+        self.step_order = attributes[:'step_order']
+      else
+        self.step_order = nil
+      end
+
+      if attributes.key?(:'step_type')
+        self.step_type = attributes[:'step_type']
+      else
+        self.step_type = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'action_type')
+        self.action_type = attributes[:'action_type']
+      else
+        self.action_type = nil
+      end
+
+      if attributes.key?(:'instruction')
+        self.instruction = attributes[:'instruction']
+      else
+        self.instruction = nil
+      end
+
+      if attributes.key?(:'required_approvals_number')
+        self.required_approvals_number = attributes[:'required_approvals_number']
+      else
+        self.required_approvals_number = nil
+      end
+
+      if attributes.key?(:'required_approvals_percent')
+        self.required_approvals_percent = attributes[:'required_approvals_percent']
+      else
+        self.required_approvals_percent = nil
+      end
+
+      if attributes.key?(:'fallback_type')
+        self.fallback_type = attributes[:'fallback_type']
+      else
+        self.fallback_type = nil
+      end
+
+      if attributes.key?(:'allow_self_approval')
+        self.allow_self_approval = attributes[:'allow_self_approval']
+      else
+        self.allow_self_approval = nil
+      end
+
+      if attributes.key?(:'min_custom_assignees')
+        self.min_custom_assignees = attributes[:'min_custom_assignees']
+      else
+        self.min_custom_assignees = nil
+      end
+
+      if attributes.key?(:'users')
+        if (value = attributes[:'users']).is_a?(Array)
+          self.users = value
+        end
+      else
+        self.users = nil
+      end
+
+      if attributes.key?(:'targets')
+        if (value = attributes[:'targets']).is_a?(Array)
+          self.targets = value
+        end
+      end
+
+      if attributes.key?(:'route_step_condition')
+        self.route_step_condition = attributes[:'route_step_condition']
+      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 @step_order.nil?
+        invalid_properties.push('invalid value for "step_order", step_order cannot be nil.')
+      end
+
+      if @step_type.nil?
+        invalid_properties.push('invalid value for "step_type", step_type cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @action_type.nil?
+        invalid_properties.push('invalid value for "action_type", action_type cannot be nil.')
+      end
+
+      if @required_approvals_number.nil?
+        invalid_properties.push('invalid value for "required_approvals_number", required_approvals_number cannot be nil.')
+      end
+
+      if @required_approvals_percent.nil?
+        invalid_properties.push('invalid value for "required_approvals_percent", required_approvals_percent cannot be nil.')
+      end
+
+      if @allow_self_approval.nil?
+        invalid_properties.push('invalid value for "allow_self_approval", allow_self_approval cannot be nil.')
+      end
+
+      if @min_custom_assignees < 0
+        invalid_properties.push('invalid value for "min_custom_assignees", must be greater than or equal to 0.')
+      end
+
+      if @users.nil?
+        invalid_properties.push('invalid value for "users", users 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 @id.nil?
+      return false if @step_order.nil?
+      return false if @step_type.nil?
+      step_type_validator = EnumAttributeValidator.new('String', ["author", "manager", "team", "user", "author_customizable", "assignee_customizable"])
+      return false unless step_type_validator.valid?(@step_type)
+      return false if @title.nil?
+      return false if @action_type.nil?
+      action_type_validator = EnumAttributeValidator.new('String', ["approve", "confirm", "none"])
+      return false unless action_type_validator.valid?(@action_type)
+      return false if @required_approvals_number.nil?
+      return false if @required_approvals_percent.nil?
+      fallback_type_validator = EnumAttributeValidator.new('String', ["direct_manager", "higher_manager", "skip"])
+      return false unless fallback_type_validator.valid?(@fallback_type)
+      return false if @allow_self_approval.nil?
+      return false if @min_custom_assignees < 0
+      return false if @users.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] step_type Object to be assigned
+    def step_type=(step_type)
+      validator = EnumAttributeValidator.new('String', ["author", "manager", "team", "user", "author_customizable", "assignee_customizable"])
+      unless validator.valid?(step_type)
+        fail ArgumentError, "invalid value for \"step_type\", must be one of #{validator.allowable_values}."
+      end
+      @step_type = step_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action_type Object to be assigned
+    def action_type=(action_type)
+      validator = EnumAttributeValidator.new('String', ["approve", "confirm", "none"])
+      unless validator.valid?(action_type)
+        fail ArgumentError, "invalid value for \"action_type\", must be one of #{validator.allowable_values}."
+      end
+      @action_type = action_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] fallback_type Object to be assigned
+    def fallback_type=(fallback_type)
+      validator = EnumAttributeValidator.new('String', ["direct_manager", "higher_manager", "skip"])
+      unless validator.valid?(fallback_type)
+        fail ArgumentError, "invalid value for \"fallback_type\", must be one of #{validator.allowable_values}."
+      end
+      @fallback_type = fallback_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_custom_assignees Value to be assigned
+    def min_custom_assignees=(min_custom_assignees)
+      if !min_custom_assignees.nil? && min_custom_assignees < 0
+        fail ArgumentError, 'invalid value for "min_custom_assignees", must be greater than or equal to 0.'
+      end
+
+      @min_custom_assignees = min_custom_assignees
+    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 &&
+          step_order == o.step_order &&
+          step_type == o.step_type &&
+          title == o.title &&
+          action_type == o.action_type &&
+          instruction == o.instruction &&
+          required_approvals_number == o.required_approvals_number &&
+          required_approvals_percent == o.required_approvals_percent &&
+          fallback_type == o.fallback_type &&
+          allow_self_approval == o.allow_self_approval &&
+          min_custom_assignees == o.min_custom_assignees &&
+          users == o.users &&
+          targets == o.targets &&
+          route_step_condition == o.route_step_condition
+    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, step_order, step_type, title, action_type, instruction, required_approvals_number, required_approvals_percent, fallback_type, allow_self_approval, min_custom_assignees, users, targets, route_step_condition].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