shortcut_client_ruby 0.0.2

data/lib/shortcut_client_ruby/models/max_search_results_exceeded_error.rb

@@ -0,0 +1,289 @@
+=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
+  # Error returned when total maximum supported results have been reached.
+  class MaxSearchResultsExceededError
+    # The name for this type of error, `maximum-results-exceeded`
+    attr_accessor :error
+
+    # An explanatory message: \"A maximum of 1000 search results are supported.\"
+    attr_accessor :message
+
+    # The maximum number of search results supported, `1000`
+    attr_accessor :maximum_results
+
+    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
+      {
+        :'error' => :'error',
+        :'message' => :'message',
+        :'maximum_results' => :'maximum-results'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'error' => :'Object',
+        :'message' => :'Object',
+        :'maximum_results' => :'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::MaxSearchResultsExceededError` 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::MaxSearchResultsExceededError`. 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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'maximum_results')
+        self.maximum_results = attributes[:'maximum_results']
+      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 @error.nil?
+        invalid_properties.push('invalid value for "error", error cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message cannot be nil.')
+      end
+
+      if @maximum_results.nil?
+        invalid_properties.push('invalid value for "maximum_results", maximum_results 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 @error.nil?
+      error_validator = EnumAttributeValidator.new('Object', ['maximum-results-exceeded'])
+      return false unless error_validator.valid?(@error)
+      return false if @message.nil?
+      return false if @maximum_results.nil?
+      maximum_results_validator = EnumAttributeValidator.new('Object', [1000])
+      return false unless maximum_results_validator.valid?(@maximum_results)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] error Object to be assigned
+    def error=(error)
+      validator = EnumAttributeValidator.new('Object', ['maximum-results-exceeded'])
+      unless validator.valid?(error)
+        fail ArgumentError, "invalid value for \"error\", must be one of #{validator.allowable_values}."
+      end
+      @error = error
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] maximum_results Object to be assigned
+    def maximum_results=(maximum_results)
+      validator = EnumAttributeValidator.new('Object', [1000])
+      unless validator.valid?(maximum_results)
+        fail ArgumentError, "invalid value for \"maximum_results\", must be one of #{validator.allowable_values}."
+      end
+      @maximum_results = maximum_results
+    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 &&
+          error == o.error &&
+          message == o.message &&
+          maximum_results == o.maximum_results
+    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
+      [error, message, maximum_results].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/member.rb

@@ -0,0 +1,395 @@
+=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
+  # Details about individual Shortcut user within the Shortcut organization that has issued the token.
+  class Member
+    # The Member's role in the Shortcut organization.
+    attr_accessor :role
+
+    # A string description of this resource.
+    attr_accessor :entity_type
+
+    # True/false boolean indicating whether the Member has been disabled within this Organization.
+    attr_accessor :disabled
+
+    # The user state, one of partial, full, disabled, or imported.  A partial            user is disabled, has no means to log in, and is not an import user.  A full            user is enabled and has a means to log in.  A disabled user is disabled and has            a means to log in.  An import user is disabled, has no means to log in, and is            marked as an import user.
+    attr_accessor :state
+
+    # The time/date the Member was last updated.
+    attr_accessor :updated_at
+
+    # Whether this member was created as a placeholder entity.
+    attr_accessor :created_without_invite
+
+    # The Member's group ids
+    attr_accessor :group_ids
+
+    # The Member's ID in Shortcut.
+    attr_accessor :id
+
+    attr_accessor :profile
+
+    # The time/date the Member was created.
+    attr_accessor :created_at
+
+    # The id of the member that replaces this one when merged.
+    attr_accessor :replaced_by
+
+    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
+      {
+        :'role' => :'role',
+        :'entity_type' => :'entity_type',
+        :'disabled' => :'disabled',
+        :'state' => :'state',
+        :'updated_at' => :'updated_at',
+        :'created_without_invite' => :'created_without_invite',
+        :'group_ids' => :'group_ids',
+        :'id' => :'id',
+        :'profile' => :'profile',
+        :'created_at' => :'created_at',
+        :'replaced_by' => :'replaced_by'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'role' => :'Object',
+        :'entity_type' => :'Object',
+        :'disabled' => :'Object',
+        :'state' => :'Object',
+        :'updated_at' => :'Object',
+        :'created_without_invite' => :'Object',
+        :'group_ids' => :'Object',
+        :'id' => :'Object',
+        :'profile' => :'Object',
+        :'created_at' => :'Object',
+        :'replaced_by' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'updated_at',
+        :'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::Member` 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::Member`. 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?(:'role')
+        self.role = attributes[:'role']
+      end
+
+      if attributes.key?(:'entity_type')
+        self.entity_type = attributes[:'entity_type']
+      end
+
+      if attributes.key?(:'disabled')
+        self.disabled = attributes[:'disabled']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'created_without_invite')
+        self.created_without_invite = attributes[:'created_without_invite']
+      end
+
+      if attributes.key?(:'group_ids')
+        if (value = attributes[:'group_ids']).is_a?(Array)
+          self.group_ids = value
+        end
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'profile')
+        self.profile = attributes[:'profile']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'replaced_by')
+        self.replaced_by = attributes[:'replaced_by']
+      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 @role.nil?
+        invalid_properties.push('invalid value for "role", role cannot be nil.')
+      end
+
+      if @entity_type.nil?
+        invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.')
+      end
+
+      if @disabled.nil?
+        invalid_properties.push('invalid value for "disabled", disabled cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @created_without_invite.nil?
+        invalid_properties.push('invalid value for "created_without_invite", created_without_invite cannot be nil.')
+      end
+
+      if @group_ids.nil?
+        invalid_properties.push('invalid value for "group_ids", group_ids cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @profile.nil?
+        invalid_properties.push('invalid value for "profile", profile 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 @role.nil?
+      return false if @entity_type.nil?
+      return false if @disabled.nil?
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('Object', ['partial', 'full', 'disabled', 'imported'])
+      return false unless state_validator.valid?(@state)
+      return false if @updated_at.nil?
+      return false if @created_without_invite.nil?
+      return false if @group_ids.nil?
+      return false if @id.nil?
+      return false if @profile.nil?
+      return false if @created_at.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('Object', ['partial', 'full', 'disabled', 'imported'])
+      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 &&
+          role == o.role &&
+          entity_type == o.entity_type &&
+          disabled == o.disabled &&
+          state == o.state &&
+          updated_at == o.updated_at &&
+          created_without_invite == o.created_without_invite &&
+          group_ids == o.group_ids &&
+          id == o.id &&
+          profile == o.profile &&
+          created_at == o.created_at &&
+          replaced_by == o.replaced_by
+    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
+      [role, entity_type, disabled, state, updated_at, created_without_invite, group_ids, id, profile, created_at, replaced_by].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