shortcut_client_ruby 0.0.2

data/lib/shortcut_client_ruby/models/create_story_contents.rb

@@ -0,0 +1,433 @@
+=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
+  # A map of story attributes this template populates.
+  class CreateStoryContents
+    # The description of the story.
+    attr_accessor :description
+
+    # A string description of this resource.
+    attr_accessor :entity_type
+
+    # An array of labels to be populated by the template.
+    attr_accessor :labels
+
+    # The type of story (feature, bug, chore).
+    attr_accessor :story_type
+
+    # An array of linked files attached to the story.
+    attr_accessor :linked_files
+
+    # An array of the attached file IDs to be populated.
+    attr_accessor :file_ids
+
+    # The name of the story.
+    attr_accessor :name
+
+    # The ID of the epic the to be populated.
+    attr_accessor :epic_id
+
+    # An array of external links to be populated.
+    attr_accessor :external_links
+
+    # The ID of the iteration the to be populated.
+    attr_accessor :iteration_id
+
+    # An array of tasks to be populated by the template.
+    attr_accessor :tasks
+
+    # An array of label ids attached to the story.
+    attr_accessor :label_ids
+
+    # The ID of the group to be populated.
+    attr_accessor :group_id
+
+    # The ID of the workflow state the story is currently in.
+    attr_accessor :workflow_state_id
+
+    # An array of UUIDs for any Members listed as Followers.
+    attr_accessor :follower_ids
+
+    # An array of UUIDs of the owners of this story.
+    attr_accessor :owner_ids
+
+    # The numeric point estimate to be populated.
+    attr_accessor :estimate
+
+    # An array of files attached to the story.
+    attr_accessor :files
+
+    # The ID of the project the story belongs to.
+    attr_accessor :project_id
+
+    # An array of the linked file IDs to be populated.
+    attr_accessor :linked_file_ids
+
+    # The due date of the story.
+    attr_accessor :deadline
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'entity_type' => :'entity_type',
+        :'labels' => :'labels',
+        :'story_type' => :'story_type',
+        :'linked_files' => :'linked_files',
+        :'file_ids' => :'file_ids',
+        :'name' => :'name',
+        :'epic_id' => :'epic_id',
+        :'external_links' => :'external_links',
+        :'iteration_id' => :'iteration_id',
+        :'tasks' => :'tasks',
+        :'label_ids' => :'label_ids',
+        :'group_id' => :'group_id',
+        :'workflow_state_id' => :'workflow_state_id',
+        :'follower_ids' => :'follower_ids',
+        :'owner_ids' => :'owner_ids',
+        :'estimate' => :'estimate',
+        :'files' => :'files',
+        :'project_id' => :'project_id',
+        :'linked_file_ids' => :'linked_file_ids',
+        :'deadline' => :'deadline'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'Object',
+        :'entity_type' => :'Object',
+        :'labels' => :'Object',
+        :'story_type' => :'Object',
+        :'linked_files' => :'Object',
+        :'file_ids' => :'Object',
+        :'name' => :'Object',
+        :'epic_id' => :'Object',
+        :'external_links' => :'Object',
+        :'iteration_id' => :'Object',
+        :'tasks' => :'Object',
+        :'label_ids' => :'Object',
+        :'group_id' => :'Object',
+        :'workflow_state_id' => :'Object',
+        :'follower_ids' => :'Object',
+        :'owner_ids' => :'Object',
+        :'estimate' => :'Object',
+        :'files' => :'Object',
+        :'project_id' => :'Object',
+        :'linked_file_ids' => :'Object',
+        :'deadline' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'epic_id',
+        :'iteration_id',
+        :'group_id',
+        :'estimate',
+        :'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::CreateStoryContents` 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::CreateStoryContents`. 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?(:'entity_type')
+        self.entity_type = attributes[:'entity_type']
+      end
+
+      if attributes.key?(:'labels')
+        if (value = attributes[:'labels']).is_a?(Array)
+          self.labels = value
+        end
+      end
+
+      if attributes.key?(:'story_type')
+        self.story_type = attributes[:'story_type']
+      end
+
+      if attributes.key?(:'linked_files')
+        if (value = attributes[:'linked_files']).is_a?(Array)
+          self.linked_files = value
+        end
+      end
+
+      if attributes.key?(:'file_ids')
+        if (value = attributes[:'file_ids']).is_a?(Array)
+          self.file_ids = value
+        end
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'epic_id')
+        self.epic_id = attributes[:'epic_id']
+      end
+
+      if attributes.key?(:'external_links')
+        if (value = attributes[:'external_links']).is_a?(Array)
+          self.external_links = value
+        end
+      end
+
+      if attributes.key?(:'iteration_id')
+        self.iteration_id = attributes[:'iteration_id']
+      end
+
+      if attributes.key?(:'tasks')
+        if (value = attributes[:'tasks']).is_a?(Array)
+          self.tasks = value
+        end
+      end
+
+      if attributes.key?(:'label_ids')
+        if (value = attributes[:'label_ids']).is_a?(Array)
+          self.label_ids = value
+        end
+      end
+
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
+      end
+
+      if attributes.key?(:'workflow_state_id')
+        self.workflow_state_id = attributes[:'workflow_state_id']
+      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?(:'estimate')
+        self.estimate = attributes[:'estimate']
+      end
+
+      if attributes.key?(:'files')
+        if (value = attributes[:'files']).is_a?(Array)
+          self.files = value
+        end
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      end
+
+      if attributes.key?(:'linked_file_ids')
+        if (value = attributes[:'linked_file_ids']).is_a?(Array)
+          self.linked_file_ids = value
+        end
+      end
+
+      if attributes.key?(:'deadline')
+        self.deadline = attributes[:'deadline']
+      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
+      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?
+      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 &&
+          description == o.description &&
+          entity_type == o.entity_type &&
+          labels == o.labels &&
+          story_type == o.story_type &&
+          linked_files == o.linked_files &&
+          file_ids == o.file_ids &&
+          name == o.name &&
+          epic_id == o.epic_id &&
+          external_links == o.external_links &&
+          iteration_id == o.iteration_id &&
+          tasks == o.tasks &&
+          label_ids == o.label_ids &&
+          group_id == o.group_id &&
+          workflow_state_id == o.workflow_state_id &&
+          follower_ids == o.follower_ids &&
+          owner_ids == o.owner_ids &&
+          estimate == o.estimate &&
+          files == o.files &&
+          project_id == o.project_id &&
+          linked_file_ids == o.linked_file_ids &&
+          deadline == o.deadline
+    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, entity_type, labels, story_type, linked_files, file_ids, name, epic_id, external_links, iteration_id, tasks, label_ids, group_id, workflow_state_id, follower_ids, owner_ids, estimate, files, project_id, linked_file_ids, deadline].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_story_link.rb

@@ -0,0 +1,276 @@
+=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 CreateStoryLink
+    # The type of link.
+    attr_accessor :verb
+
+    # The ID of the subject Story.
+    attr_accessor :subject_id
+
+    # The ID of the object Story.
+    attr_accessor :object_id
+
+    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
+      {
+        :'verb' => :'verb',
+        :'subject_id' => :'subject_id',
+        :'object_id' => :'object_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'verb' => :'Object',
+        :'subject_id' => :'Object',
+        :'object_id' => :'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::CreateStoryLink` 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::CreateStoryLink`. 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?(:'verb')
+        self.verb = attributes[:'verb']
+      end
+
+      if attributes.key?(:'subject_id')
+        self.subject_id = attributes[:'subject_id']
+      end
+
+      if attributes.key?(:'object_id')
+        self.object_id = attributes[:'object_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
+      invalid_properties = Array.new
+      if @verb.nil?
+        invalid_properties.push('invalid value for "verb", verb cannot be nil.')
+      end
+
+      if @subject_id.nil?
+        invalid_properties.push('invalid value for "subject_id", subject_id cannot be nil.')
+      end
+
+      if @object_id.nil?
+        invalid_properties.push('invalid value for "object_id", object_id 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 @verb.nil?
+      verb_validator = EnumAttributeValidator.new('Object', ['blocks', 'duplicates', 'relates to'])
+      return false unless verb_validator.valid?(@verb)
+      return false if @subject_id.nil?
+      return false if @object_id.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] verb Object to be assigned
+    def verb=(verb)
+      validator = EnumAttributeValidator.new('Object', ['blocks', 'duplicates', 'relates to'])
+      unless validator.valid?(verb)
+        fail ArgumentError, "invalid value for \"verb\", must be one of #{validator.allowable_values}."
+      end
+      @verb = verb
+    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 &&
+          verb == o.verb &&
+          subject_id == o.subject_id &&
+          object_id == o.object_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
+      [verb, subject_id, object_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)
+      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