stackone_hris_client 1.1.0 → 1.2.0

data/lib/stackone_hris_client/api/locations_api.rb

@@ -0,0 +1,188 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'cgi'
+
+module StackOneHRIS
+  class LocationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 
+    # @param id [String] 
+    # @param x_account_id [String] The account identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page The page number of the results to fetch
+    # @option opts [String] :page_size The number of results per page (default to '25')
+    # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
+    # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
+    # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
+    # @option opts [String] :sync_token The sync token to select the only updated results
+    # @return [LocationResult]
+    def hris_locations_get(id, x_account_id, opts = {})
+      data, _status_code, _headers = hris_locations_get_with_http_info(id, x_account_id, opts)
+      data
+    end
+
+    # 
+    # @param id [String] 
+    # @param x_account_id [String] The account identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page The page number of the results to fetch
+    # @option opts [String] :page_size The number of results per page (default to '25')
+    # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
+    # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
+    # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
+    # @option opts [String] :sync_token The sync token to select the only updated results
+    # @return [Array<(LocationResult, Integer, Hash)>] LocationResult data, response status code and response headers
+    def hris_locations_get_with_http_info(id, x_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LocationsApi.hris_locations_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling LocationsApi.hris_locations_get"
+      end
+      # verify the required parameter 'x_account_id' is set
+      if @api_client.config.client_side_validation && x_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_id' when calling LocationsApi.hris_locations_get"
+      end
+      # resource path
+      local_var_path = '/unified/hris/locations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
+      query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-account-id'] = x_account_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LocationResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basic']
+
+      new_options = opts.merge(
+        :operation => :"LocationsApi.hris_locations_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationsApi#hris_locations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # @param x_account_id [String] The account identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page The page number of the results to fetch
+    # @option opts [String] :page_size The number of results per page (default to '25')
+    # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
+    # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
+    # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
+    # @option opts [String] :sync_token The sync token to select the only updated results
+    # @return [LocationsPaginated]
+    def hris_locations_list(x_account_id, opts = {})
+      data, _status_code, _headers = hris_locations_list_with_http_info(x_account_id, opts)
+      data
+    end
+
+    # 
+    # @param x_account_id [String] The account identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page The page number of the results to fetch
+    # @option opts [String] :page_size The number of results per page (default to '25')
+    # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
+    # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
+    # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
+    # @option opts [String] :sync_token The sync token to select the only updated results
+    # @return [Array<(LocationsPaginated, Integer, Hash)>] LocationsPaginated data, response status code and response headers
+    def hris_locations_list_with_http_info(x_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LocationsApi.hris_locations_list ...'
+      end
+      # verify the required parameter 'x_account_id' is set
+      if @api_client.config.client_side_validation && x_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_id' when calling LocationsApi.hris_locations_list"
+      end
+      # resource path
+      local_var_path = '/unified/hris/locations'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
+      query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-account-id'] = x_account_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LocationsPaginated'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basic']
+
+      new_options = opts.merge(
+        :operation => :"LocationsApi.hris_locations_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationsApi#hris_locations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/stackone_hris_client/api_client.rb

@@ -1,9 +1,9 @@
 =begin
-#StackOne Unified API
+#StackOne Unified API - HRIS
 
-#The documentation for the StackOne Unified API
+#The documentation for the StackOne Unified API - HRIS
 
-The version of the OpenAPI document: 1.0
+The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.4.0
@@ -17,7 +17,7 @@ require 'tempfile'
 require 'time'
 require 'typhoeus'
 
-module StackOneHrisClient
+module StackOneHRIS
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
     attr_accessor :config
@@ -278,7 +278,7 @@ module StackOneHrisClient
         end
       else
         # models (e.g. Pet) or oneOf
-        klass = StackOneHrisClient.const_get(return_type)
+        klass = StackOneHRIS.const_get(return_type)
         klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
       end
     end

data/lib/stackone_hris_client/api_error.rb

@@ -1,16 +1,16 @@
 =begin
-#StackOne Unified API
+#StackOne Unified API - HRIS
 
-#The documentation for the StackOne Unified API
+#The documentation for the StackOne Unified API - HRIS
 
-The version of the OpenAPI document: 1.0
+The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.4.0
 
 =end
 
-module StackOneHrisClient
+module StackOneHRIS
   class ApiError < StandardError
     attr_reader :code, :response_headers, :response_body
 

data/lib/stackone_hris_client/configuration.rb

@@ -1,16 +1,16 @@
 =begin
-#StackOne Unified API
+#StackOne Unified API - HRIS
 
-#The documentation for the StackOne Unified API
+#The documentation for the StackOne Unified API - HRIS
 
-The version of the OpenAPI document: 1.0
+The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.4.0
 
 =end
 
-module StackOneHrisClient
+module StackOneHRIS
   class Configuration
     # Defines url scheme
     attr_accessor :scheme

data/lib/stackone_hris_client/models/account.rb

@@ -1,9 +1,9 @@
 =begin
-#StackOne Unified API
+#StackOne Unified API - HRIS
 
-#The documentation for the StackOne Unified API
+#The documentation for the StackOne Unified API - HRIS
 
-The version of the OpenAPI document: 1.0
+The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.4.0
@@ -13,7 +13,7 @@ OpenAPI Generator version: 6.4.0
 require 'date'
 require 'time'
 
-module StackOneHrisClient
+module StackOneHRIS
   class Account
     attr_accessor :id
 
@@ -74,13 +74,13 @@ module StackOneHrisClient
     # @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 `StackOneHrisClient::Account` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `StackOneHRIS::Account` 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 `StackOneHrisClient::Account`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `StackOneHRIS::Account`. 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
       }
@@ -266,7 +266,7 @@ module StackOneHrisClient
         end
       else # model
         # models (e.g. Pet) or oneOf
-        klass = StackOneHrisClient.const_get(type)
+        klass = StackOneHRIS.const_get(type)
         klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
@@ -316,5 +316,7 @@ module StackOneHrisClient
         value
       end
     end
+
   end
+
 end

data/lib/stackone_hris_client/models/companies_paginated.rb

@@ -0,0 +1,249 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module StackOneHRIS
+  class CompaniesPaginated
+    attr_accessor :next_page
+
+    attr_accessor :data
+
+    attr_accessor :raw
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'next_page' => :'next_page',
+        :'data' => :'data',
+        :'raw' => :'raw'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'next_page' => :'String',
+        :'data' => :'Array<Company>',
+        :'raw' => :'String'
+      }
+    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 `StackOneHRIS::CompaniesPaginated` 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 `StackOneHRIS::CompaniesPaginated`. 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?(:'next_page')
+        self.next_page = attributes[:'next_page']
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'raw')
+        self.raw = attributes[:'raw']
+      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 @next_page.nil?
+        invalid_properties.push('invalid value for "next_page", next_page cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @next_page.nil?
+      return false if @data.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 &&
+          next_page == o.next_page &&
+          data == o.data &&
+          raw == o.raw
+    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
+      [next_page, data, raw].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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]]))
+        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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = StackOneHRIS.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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