wheniwork-ruby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acd8c2c06b0a7168759c92a0f5119b67d0fb75a5
-  data.tar.gz: 6d57508eb61fe6e4972fe5df9d0df86b21f854e6
+  metadata.gz: 938c7530237eca3b33407d27f212329243b948c6
+  data.tar.gz: d966a80396eff2f89a91ad3ba1dcb7f6204e4c94
 SHA512:
-  metadata.gz: b68c5ead9587f435fd3587bed2070195328a3c3fd16ced6f8f84ed5f8ebc60f186bc26030d9585b3194f5432e23f8c76daf7cba6927b4e7f218d11f5cbb102f7
-  data.tar.gz: 0021e58201f70e7c35775b7f23be2f0bfd4640233f87025106907cb0b88cb3a3f9a1c959800312f2b2c5b39e11aa499a87755add3774276a7145ec885de7ad0d
+  metadata.gz: 095ba8fc74d42067f686f68c3c87b45545e994efb06afca00ba376b4f612a6cb1ee04d41dac34cdd2337b203c74a89f239b0a8382f06251aa7fc98522ec51bc0
+  data.tar.gz: a8d28b58f67cc243581da5e0ca2c087d3a0849510f2b5e228ca5a3661ae7194539ea50941142ddfcd2bc9face9a7c78127415f198eec5ab2b05ac3f7b91d5f5f

data/README.md

@@ -7,7 +7,7 @@ This SDK is automatically generated by the [Swagger Codegen](https://github.com/
 
 - API version: v2
 - Package version: 1.0.0
-- Build date: 2016-05-24T22:52:38.925-04:00
+- Build date: 2016-05-25T14:18:09.696-04:00
 - Build package: class io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
 *WhenIWork::Api* | [**get_shift**](docs/Api.md#get_shift) | **GET** /shifts/{shift-id} |
 *WhenIWork::Api* | [**get_shifts**](docs/Api.md#get_shifts) | **GET** /shifts |
 *WhenIWork::Api* | [**get_user**](docs/Api.md#get_user) | **GET** /users/{user-id} |
+*WhenIWork::Api* | [**get_users**](docs/Api.md#get_users) | **GET** /users |
 
 
 ## Documentation for Models
@@ -95,6 +96,7 @@ Class | Method | HTTP request | Description
  - [WhenIWork::InlineResponse2001](docs/InlineResponse2001.md)
  - [WhenIWork::InlineResponse2002](docs/InlineResponse2002.md)
  - [WhenIWork::InlineResponse2003](docs/InlineResponse2003.md)
+ - [WhenIWork::InlineResponse2004](docs/InlineResponse2004.md)
  - [WhenIWork::Position](docs/Position.md)
  - [WhenIWork::Shift](docs/Shift.md)
  - [WhenIWork::User](docs/User.md)

data/docs/InlineResponse2003.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**user** | [**User**](User.md) |  | [optional] 
+**users** | [**Array<User>**](User.md) |  | [optional] 
 
 

data/docs/InlineResponse2004.md

@@ -0,0 +1,8 @@
+# WhenIWork::InlineResponse2004
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**User**](User.md) |  | [optional] 
+
+

data/lib/wheniwork-ruby.rb

@@ -24,12 +24,14 @@ require 'wheniwork-ruby/api_client'
 require 'wheniwork-ruby/api_error'
 require 'wheniwork-ruby/version'
 require 'wheniwork-ruby/configuration'
+require 'wheniwork-ruby/modules/response'
 
 # Models
 require 'wheniwork-ruby/models/inline_response_200'
 require 'wheniwork-ruby/models/inline_response_200_1'
 require 'wheniwork-ruby/models/inline_response_200_2'
 require 'wheniwork-ruby/models/inline_response_200_3'
+require 'wheniwork-ruby/models/inline_response_200_4'
 require 'wheniwork-ruby/models/position'
 require 'wheniwork-ruby/models/shift'
 require 'wheniwork-ruby/models/user'
@@ -37,6 +39,8 @@ require 'wheniwork-ruby/models/user'
 # APIs
 require 'wheniwork-ruby/api/api'
 
+# modules
+
 module WhenIWork
   class << self
     # Customize default settings for the SDK using block.

data/lib/wheniwork-ruby/api/api.rb

@@ -146,8 +146,8 @@ module WhenIWork
     # Get a list of shifts.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id The ID of the user to get shifts for. For multiple users, enter a list of user IDs separated by commas (e.g. 1,5,3).
-    # @option opts [DateTime] :start Start time for the search window. The default is the current date and time
-    # @option opts [DateTime] :_end End time for the search window. The default is exactly three days from the start time.
+    # @option opts [DateTime] :start_time Start time for the search window. The default is the current date and time
+    # @option opts [DateTime] :end_time End time for the search window. The default is exactly three days from the start time.
     # @option opts [String] :location_id The ID of the location to get shifts for. For multiple locations, enter a list of location IDs separated by commas.
     # @option opts [String] :position_id The ID of the position to get shifts for. For multiple position, enter a list of position IDs separated by commas.
     # @option opts [BOOLEAN] :include_open Whether to include OpenShifts in the results.
@@ -163,8 +163,8 @@ module WhenIWork
     # Get a list of shifts.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id The ID of the user to get shifts for. For multiple users, enter a list of user IDs separated by commas (e.g. 1,5,3).
-    # @option opts [DateTime] :start Start time for the search window. The default is the current date and time
-    # @option opts [DateTime] :_end End time for the search window. The default is exactly three days from the start time.
+    # @option opts [DateTime] :start_date Start time for the search window. The default is the current date and time
+    # @option opts [DateTime] :end_date End time for the search window. The default is exactly three days from the start time.
     # @option opts [String] :location_id The ID of the location to get shifts for. For multiple locations, enter a list of location IDs separated by commas.
     # @option opts [String] :position_id The ID of the position to get shifts for. For multiple position, enter a list of position IDs separated by commas.
     # @option opts [BOOLEAN] :include_open Whether to include OpenShifts in the results.
@@ -181,8 +181,8 @@ module WhenIWork
       # query parameters
       query_params = {}
       query_params[:'user_id'] = opts[:'user_id'] if opts[:'user_id']
-      query_params[:'start'] = opts[:'start'] if opts[:'start']
-      query_params[:'end'] = opts[:'_end'] if opts[:'_end']
+      query_params[:'start'] = opts[:'start_date'] if opts[:'start_date']
+      query_params[:'end'] = opts[:'end_date'] if opts[:'end_date']
       query_params[:'location_id'] = opts[:'location_id'] if opts[:'location_id']
       query_params[:'position_id'] = opts[:'position_id'] if opts[:'position_id']
       query_params[:'include_open'] = opts[:'include_open'] if opts[:'include_open']
@@ -275,5 +275,69 @@ module WhenIWork
       end
       return data, status_code, headers
     end
+
+    #
+    # Get a list of users.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ids The IDs of the users to retrieve, as a comma-separated list (e.g. 9,17,42).
+    # @option opts [String] :location_id The ID of the location to get users for. For multiple locations, enter a list of location IDs separated by commas.
+    # @option opts [BOOLEAN] :show_deleted Whether to include deleted users in the results. Defaults to false.
+    # @return [InlineResponse2003]
+    def get_users(opts = {})
+      data, status_code, headers = get_users_with_http_info(opts)
+      return data
+    end
+
+    #
+    # Get a list of users.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ids The IDs of the users to retrieve, as a comma-separated list (e.g. 9,17,42).
+    # @option opts [String] :location_id The ID of the location to get users for. For multiple locations, enter a list of location IDs separated by commas.
+    # @option opts [BOOLEAN] :show_deleted Whether to include deleted users in the results. Defaults to false.
+    # @return [Array<(InlineResponse2003, Fixnum, Hash)>] InlineResponse2003 data, response status code and response headers
+    def get_users_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi#get_users ..."
+      end
+
+      # resource path
+      local_var_path = "/users".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'ids'] = opts[:'ids'] if opts[:'ids']
+      query_params[:'location_id'] = opts[:'location_id'] if opts[:'location_id']
+      query_params[:'show_deleted'] = opts[:'show_deleted'] if opts[:'show_deleted']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+
+      auth_names = ['apiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse2003')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/wheniwork-ruby/models/inline_response_200.rb

@@ -22,8 +22,9 @@ limitations under the License.
 require 'date'
 
 module WhenIWork
-
   class InlineResponse200
+    include WhenIWork::Response
+
     attr_accessor :positions
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -53,7 +54,6 @@ module WhenIWork
           self.positions = value
         end
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -71,15 +71,8 @@ module WhenIWork
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          positions == o.positions
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
+      return true if equal?(o)
+      self.class == o.class && positions == o.positions
     end
 
     # Calculates hash code according to all attributes.
@@ -87,109 +80,5 @@ module WhenIWork
     def hash
       [positions].hash
     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.swagger_types.each_pair do |key, type|
-        if type =~ /^Array<(.*)>/i
-          # check to ensure the input is an array given that the 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]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
-      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 =~ /^(true|t|yes|y|1)$/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
-        temp_model = WhenIWork.const_get(type).new
-        temp_model.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)
-        next if value.nil?
-        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/wheniwork-ruby/models/inline_response_200_1.rb

@@ -22,8 +22,9 @@ limitations under the License.
 require 'date'
 
 module WhenIWork
-
   class InlineResponse2001
+    include WhenIWork::Response
+
     attr_accessor :start
 
     attr_accessor :_end
@@ -94,38 +95,12 @@ module WhenIWork
           shifts == o.shifts
     end
 
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
       [start, _end, shifts].hash
     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.swagger_types.each_pair do |key, type|
-        if type =~ /^Array<(.*)>/i
-          # check to ensure the input is an array given that the 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]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
-      end
-
-      self
-    end
-
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
@@ -209,7 +184,5 @@ module WhenIWork
         value
       end
     end
-
   end
-
 end

data/lib/wheniwork-ruby/models/inline_response_200_2.rb

@@ -22,8 +22,9 @@ limitations under the License.
 require 'date'
 
 module WhenIWork
-
   class InlineResponse2002
+    include WhenIWork::Response
+
     attr_accessor :shift
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -74,122 +75,10 @@ module WhenIWork
           shift == o.shift
     end
 
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
       [shift].hash
     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.swagger_types.each_pair do |key, type|
-        if type =~ /^Array<(.*)>/i
-          # check to ensure the input is an array given that the 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]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
-      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 =~ /^(true|t|yes|y|1)$/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
-        temp_model = WhenIWork.const_get(type).new
-        temp_model.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)
-        next if value.nil?
-        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