shortcut_client_ruby 0.0.2

data/lib/shortcut_client_ruby/models/iteration_stats.rb

@@ -0,0 +1,353 @@
+=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 group of calculated values for this Iteration.
+  class IterationStats
+    # The total number of completed points in this Iteration.
+    attr_accessor :num_points_done
+
+    # The total number of documents related to an Iteration
+    attr_accessor :num_related_documents
+
+    # The average cycle time (in seconds) of completed stories in this Iteration.
+    attr_accessor :average_cycle_time
+
+    # The total number of unstarted Stories in this Iteration.
+    attr_accessor :num_stories_unstarted
+
+    # The total number of started points in this Iteration.
+    attr_accessor :num_points_started
+
+    # The total number of unstarted points in this Iteration.
+    attr_accessor :num_points_unstarted
+
+    # The total number of started Stories in this Iteration.
+    attr_accessor :num_stories_started
+
+    # The total number of Stories with no point estimate.
+    attr_accessor :num_stories_unestimated
+
+    # The average lead time (in seconds) of completed stories in this Iteration.
+    attr_accessor :average_lead_time
+
+    # The total number of points in this Iteration.
+    attr_accessor :num_points
+
+    # The total number of done Stories in this Iteration.
+    attr_accessor :num_stories_done
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'num_points_done' => :'num_points_done',
+        :'num_related_documents' => :'num_related_documents',
+        :'average_cycle_time' => :'average_cycle_time',
+        :'num_stories_unstarted' => :'num_stories_unstarted',
+        :'num_points_started' => :'num_points_started',
+        :'num_points_unstarted' => :'num_points_unstarted',
+        :'num_stories_started' => :'num_stories_started',
+        :'num_stories_unestimated' => :'num_stories_unestimated',
+        :'average_lead_time' => :'average_lead_time',
+        :'num_points' => :'num_points',
+        :'num_stories_done' => :'num_stories_done'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'num_points_done' => :'Object',
+        :'num_related_documents' => :'Object',
+        :'average_cycle_time' => :'Object',
+        :'num_stories_unstarted' => :'Object',
+        :'num_points_started' => :'Object',
+        :'num_points_unstarted' => :'Object',
+        :'num_stories_started' => :'Object',
+        :'num_stories_unestimated' => :'Object',
+        :'average_lead_time' => :'Object',
+        :'num_points' => :'Object',
+        :'num_stories_done' => :'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::IterationStats` 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::IterationStats`. 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?(:'num_points_done')
+        self.num_points_done = attributes[:'num_points_done']
+      end
+
+      if attributes.key?(:'num_related_documents')
+        self.num_related_documents = attributes[:'num_related_documents']
+      end
+
+      if attributes.key?(:'average_cycle_time')
+        self.average_cycle_time = attributes[:'average_cycle_time']
+      end
+
+      if attributes.key?(:'num_stories_unstarted')
+        self.num_stories_unstarted = attributes[:'num_stories_unstarted']
+      end
+
+      if attributes.key?(:'num_points_started')
+        self.num_points_started = attributes[:'num_points_started']
+      end
+
+      if attributes.key?(:'num_points_unstarted')
+        self.num_points_unstarted = attributes[:'num_points_unstarted']
+      end
+
+      if attributes.key?(:'num_stories_started')
+        self.num_stories_started = attributes[:'num_stories_started']
+      end
+
+      if attributes.key?(:'num_stories_unestimated')
+        self.num_stories_unestimated = attributes[:'num_stories_unestimated']
+      end
+
+      if attributes.key?(:'average_lead_time')
+        self.average_lead_time = attributes[:'average_lead_time']
+      end
+
+      if attributes.key?(:'num_points')
+        self.num_points = attributes[:'num_points']
+      end
+
+      if attributes.key?(:'num_stories_done')
+        self.num_stories_done = attributes[:'num_stories_done']
+      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 @num_points_done.nil?
+        invalid_properties.push('invalid value for "num_points_done", num_points_done cannot be nil.')
+      end
+
+      if @num_related_documents.nil?
+        invalid_properties.push('invalid value for "num_related_documents", num_related_documents cannot be nil.')
+      end
+
+      if @num_stories_unstarted.nil?
+        invalid_properties.push('invalid value for "num_stories_unstarted", num_stories_unstarted cannot be nil.')
+      end
+
+      if @num_points_started.nil?
+        invalid_properties.push('invalid value for "num_points_started", num_points_started cannot be nil.')
+      end
+
+      if @num_points_unstarted.nil?
+        invalid_properties.push('invalid value for "num_points_unstarted", num_points_unstarted cannot be nil.')
+      end
+
+      if @num_stories_started.nil?
+        invalid_properties.push('invalid value for "num_stories_started", num_stories_started cannot be nil.')
+      end
+
+      if @num_stories_unestimated.nil?
+        invalid_properties.push('invalid value for "num_stories_unestimated", num_stories_unestimated cannot be nil.')
+      end
+
+      if @num_points.nil?
+        invalid_properties.push('invalid value for "num_points", num_points cannot be nil.')
+      end
+
+      if @num_stories_done.nil?
+        invalid_properties.push('invalid value for "num_stories_done", num_stories_done 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 @num_points_done.nil?
+      return false if @num_related_documents.nil?
+      return false if @num_stories_unstarted.nil?
+      return false if @num_points_started.nil?
+      return false if @num_points_unstarted.nil?
+      return false if @num_stories_started.nil?
+      return false if @num_stories_unestimated.nil?
+      return false if @num_points.nil?
+      return false if @num_stories_done.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 &&
+          num_points_done == o.num_points_done &&
+          num_related_documents == o.num_related_documents &&
+          average_cycle_time == o.average_cycle_time &&
+          num_stories_unstarted == o.num_stories_unstarted &&
+          num_points_started == o.num_points_started &&
+          num_points_unstarted == o.num_points_unstarted &&
+          num_stories_started == o.num_stories_started &&
+          num_stories_unestimated == o.num_stories_unestimated &&
+          average_lead_time == o.average_lead_time &&
+          num_points == o.num_points &&
+          num_stories_done == o.num_stories_done
+    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
+      [num_points_done, num_related_documents, average_cycle_time, num_stories_unstarted, num_points_started, num_points_unstarted, num_stories_started, num_stories_unestimated, average_lead_time, num_points, num_stories_done].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/label.rb

@@ -0,0 +1,362 @@
+=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 Label can be used to associate and filter Stories and Epics, and also create new Workspaces.
+  class Label
+    # The Shortcut application url for the Label.
+    attr_accessor :app_url
+
+    # The description of the Label.
+    attr_accessor :description
+
+    # A true/false boolean indicating if the Label has been archived.
+    attr_accessor :archived
+
+    # A string description of this resource.
+    attr_accessor :entity_type
+
+    # The hex color to be displayed with the Label (for example, \"#ff0000\").
+    attr_accessor :color
+
+    # The name of the Label.
+    attr_accessor :name
+
+    # The time/date that the Label was updated.
+    attr_accessor :updated_at
+
+    # This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here.
+    attr_accessor :external_id
+
+    # The unique ID of the Label.
+    attr_accessor :id
+
+    attr_accessor :stats
+
+    # The time/date that the Label was created.
+    attr_accessor :created_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'app_url' => :'app_url',
+        :'description' => :'description',
+        :'archived' => :'archived',
+        :'entity_type' => :'entity_type',
+        :'color' => :'color',
+        :'name' => :'name',
+        :'updated_at' => :'updated_at',
+        :'external_id' => :'external_id',
+        :'id' => :'id',
+        :'stats' => :'stats',
+        :'created_at' => :'created_at'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'app_url' => :'Object',
+        :'description' => :'Object',
+        :'archived' => :'Object',
+        :'entity_type' => :'Object',
+        :'color' => :'Object',
+        :'name' => :'Object',
+        :'updated_at' => :'Object',
+        :'external_id' => :'Object',
+        :'id' => :'Object',
+        :'stats' => :'Object',
+        :'created_at' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'color',
+        :'updated_at',
+        :'external_id',
+        :'created_at'
+      ])
+    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::Label` 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::Label`. 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?(:'app_url')
+        self.app_url = attributes[:'app_url']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'archived')
+        self.archived = attributes[:'archived']
+      end
+
+      if attributes.key?(:'entity_type')
+        self.entity_type = attributes[:'entity_type']
+      end
+
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'stats')
+        self.stats = attributes[:'stats']
+      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 @app_url.nil?
+        invalid_properties.push('invalid value for "app_url", app_url cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @archived.nil?
+        invalid_properties.push('invalid value for "archived", archived cannot be nil.')
+      end
+
+      if @entity_type.nil?
+        invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.')
+      end
+
+      if @color.nil?
+        invalid_properties.push('invalid value for "color", color cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @external_id.nil?
+        invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at 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 @app_url.nil?
+      return false if @description.nil?
+      return false if @archived.nil?
+      return false if @entity_type.nil?
+      return false if @color.nil?
+      return false if @name.nil?
+      return false if @updated_at.nil?
+      return false if @external_id.nil?
+      return false if @id.nil?
+      return false if @created_at.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 &&
+          app_url == o.app_url &&
+          description == o.description &&
+          archived == o.archived &&
+          entity_type == o.entity_type &&
+          color == o.color &&
+          name == o.name &&
+          updated_at == o.updated_at &&
+          external_id == o.external_id &&
+          id == o.id &&
+          stats == o.stats &&
+          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
+      [app_url, description, archived, entity_type, color, name, updated_at, external_id, id, stats, 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