shortcut_client_ruby 0.0.2

data/lib/shortcut_client_ruby/models/create_entity_template.rb

@@ -0,0 +1,237 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+require 'date'
+
+module Shortcut
+  # Request paramaters for creating an entirely new entity template.
+  class CreateEntityTemplate
+    # The name of the new entity template
+    attr_accessor :name
+
+    # The id of the user creating this template.
+    attr_accessor :author_id
+
+    attr_accessor :story_contents
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'author_id' => :'author_id',
+        :'story_contents' => :'story_contents'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'Object',
+        :'author_id' => :'Object',
+        :'story_contents' => :'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 `Shortcut::CreateEntityTemplate` 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 `Shortcut::CreateEntityTemplate`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'author_id')
+        self.author_id = attributes[:'author_id']
+      end
+
+      if attributes.key?(:'story_contents')
+        self.story_contents = attributes[:'story_contents']
+      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
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @story_contents.nil?
+        invalid_properties.push('invalid value for "story_contents", story_contents 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?
+      return false if @name.nil?
+      return false if @story_contents.nil?
+      true
+    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 &&
+          author_id == o.author_id &&
+          story_contents == o.story_contents
+    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, author_id, story_contents].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
+        Shortcut.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/shortcut_client_ruby/models/create_epic.rb

@@ -0,0 +1,416 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+require 'date'
+
+module Shortcut
+  class CreateEpic
+    # The Epic's description.
+    attr_accessor :description
+
+    # An array of Labels attached to the Epic.
+    attr_accessor :labels
+
+    # A manual override for the time/date the Epic was completed.
+    attr_accessor :completed_at_override
+
+    # The Epic's name.
+    attr_accessor :name
+
+    # The Epic's planned start date.
+    attr_accessor :planned_start_date
+
+    # `Deprecated` The Epic's state (to do, in progress, or done); will be ignored when `epic_state_id` is set.
+    attr_accessor :state
+
+    # The ID of the Milestone this Epic is related to.
+    attr_accessor :milestone_id
+
+    # The ID of the member that requested the epic.
+    attr_accessor :requested_by_id
+
+    # The ID of the Epic State.
+    attr_accessor :epic_state_id
+
+    # A manual override for the time/date the Epic was started.
+    attr_accessor :started_at_override
+
+    # The ID of the group to associate with the epic.
+    attr_accessor :group_id
+
+    # Defaults to the time/date it is created but can be set to reflect another date.
+    attr_accessor :updated_at
+
+    # An array of UUIDs for any Members you want to add as Followers on this new Epic.
+    attr_accessor :follower_ids
+
+    # An array of UUIDs for any members you want to add as Owners on this new Epic.
+    attr_accessor :owner_ids
+
+    # This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.
+    attr_accessor :external_id
+
+    # The Epic's deadline.
+    attr_accessor :deadline
+
+    # Defaults to the time/date it is created but can be set to reflect another date.
+    attr_accessor :created_at
+
+    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
+      {
+        :'description' => :'description',
+        :'labels' => :'labels',
+        :'completed_at_override' => :'completed_at_override',
+        :'name' => :'name',
+        :'planned_start_date' => :'planned_start_date',
+        :'state' => :'state',
+        :'milestone_id' => :'milestone_id',
+        :'requested_by_id' => :'requested_by_id',
+        :'epic_state_id' => :'epic_state_id',
+        :'started_at_override' => :'started_at_override',
+        :'group_id' => :'group_id',
+        :'updated_at' => :'updated_at',
+        :'follower_ids' => :'follower_ids',
+        :'owner_ids' => :'owner_ids',
+        :'external_id' => :'external_id',
+        :'deadline' => :'deadline',
+        :'created_at' => :'created_at'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'Object',
+        :'labels' => :'Object',
+        :'completed_at_override' => :'Object',
+        :'name' => :'Object',
+        :'planned_start_date' => :'Object',
+        :'state' => :'Object',
+        :'milestone_id' => :'Object',
+        :'requested_by_id' => :'Object',
+        :'epic_state_id' => :'Object',
+        :'started_at_override' => :'Object',
+        :'group_id' => :'Object',
+        :'updated_at' => :'Object',
+        :'follower_ids' => :'Object',
+        :'owner_ids' => :'Object',
+        :'external_id' => :'Object',
+        :'deadline' => :'Object',
+        :'created_at' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'planned_start_date',
+        :'milestone_id',
+        :'group_id',
+        :'deadline',
+      ])
+    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 `Shortcut::CreateEpic` 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 `Shortcut::CreateEpic`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'labels')
+        if (value = attributes[:'labels']).is_a?(Array)
+          self.labels = value
+        end
+      end
+
+      if attributes.key?(:'completed_at_override')
+        self.completed_at_override = attributes[:'completed_at_override']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'planned_start_date')
+        self.planned_start_date = attributes[:'planned_start_date']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'milestone_id')
+        self.milestone_id = attributes[:'milestone_id']
+      end
+
+      if attributes.key?(:'requested_by_id')
+        self.requested_by_id = attributes[:'requested_by_id']
+      end
+
+      if attributes.key?(:'epic_state_id')
+        self.epic_state_id = attributes[:'epic_state_id']
+      end
+
+      if attributes.key?(:'started_at_override')
+        self.started_at_override = attributes[:'started_at_override']
+      end
+
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'follower_ids')
+        if (value = attributes[:'follower_ids']).is_a?(Array)
+          self.follower_ids = value
+        end
+      end
+
+      if attributes.key?(:'owner_ids')
+        if (value = attributes[:'owner_ids']).is_a?(Array)
+          self.owner_ids = value
+        end
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
+      if attributes.key?(:'deadline')
+        self.deadline = attributes[:'deadline']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      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
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name 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?
+      return false if @name.nil?
+      state_validator = EnumAttributeValidator.new('Object', ['in progress', 'to do', 'done'])
+      return false unless state_validator.valid?(@state)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('Object', ['in progress', 'to do', 'done'])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    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 &&
+          description == o.description &&
+          labels == o.labels &&
+          completed_at_override == o.completed_at_override &&
+          name == o.name &&
+          planned_start_date == o.planned_start_date &&
+          state == o.state &&
+          milestone_id == o.milestone_id &&
+          requested_by_id == o.requested_by_id &&
+          epic_state_id == o.epic_state_id &&
+          started_at_override == o.started_at_override &&
+          group_id == o.group_id &&
+          updated_at == o.updated_at &&
+          follower_ids == o.follower_ids &&
+          owner_ids == o.owner_ids &&
+          external_id == o.external_id &&
+          deadline == o.deadline &&
+          created_at == o.created_at
+    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
+      [description, labels, completed_at_override, name, planned_start_date, state, milestone_id, requested_by_id, epic_state_id, started_at_override, group_id, updated_at, follower_ids, owner_ids, external_id, deadline, created_at].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
+        Shortcut.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