merge_hris_client 1.0.4 → 2.0.2

data/lib/merge_hris_client/api/time_off_api.rb

@@ -23,6 +23,7 @@ module MergeHRISClient
     # @param x_account_token [String] Token identifying the end user.
     # @param time_off_endpoint_request [TimeOffEndpointRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :is_debug_mode Whether to include debug fields (such as log file links) in the response.
     # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
     # @return [TimeOffResponse]
     def time_off_create(x_account_token, time_off_endpoint_request, opts = {})
@@ -34,6 +35,7 @@ module MergeHRISClient
     # @param x_account_token [String] Token identifying the end user.
     # @param time_off_endpoint_request [TimeOffEndpointRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :is_debug_mode Whether to include debug fields (such as log file links) in the response.
     # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
     # @return [Array<(TimeOffResponse, Integer, Hash)>] TimeOffResponse data, response status code and response headers
     def time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts = {})
@@ -53,6 +55,7 @@ module MergeHRISClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'is_debug_mode'] = opts[:'is_debug_mode'] if !opts[:'is_debug_mode'].nil?
       query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?
 
       # header parameters
@@ -208,6 +211,68 @@ module MergeHRISClient
       return data, status_code, headers
     end
 
+    # Returns metadata for `TimeOff` POSTs.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [MetaResponse]
+    def time_off_meta_post_retrieve(x_account_token, opts = {})
+      data, _status_code, _headers = time_off_meta_post_retrieve_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns metadata for &#x60;TimeOff&#x60; POSTs.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MetaResponse, Integer, Hash)>] MetaResponse data, response status code and response headers
+    def time_off_meta_post_retrieve_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TimeOffApi.time_off_meta_post_retrieve ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TimeOffApi.time_off_meta_post_retrieve"
+      end
+      # resource path
+      local_var_path = '/time-off/meta/post'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MetaResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"TimeOffApi.time_off_meta_post_retrieve",
+        :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: TimeOffApi#time_off_meta_post_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Returns a `TimeOff` object with the given `id`.
     # @param x_account_token [String] Token identifying the end user.
     # @param id [String] 

data/lib/merge_hris_client/api/webhook_receivers_api.rb

@@ -0,0 +1,154 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'cgi'
+
+module MergeHRISClient
+  class WebhookReceiversApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Creates a `WebhookReceiver` object with the given values.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param webhook_receiver_request [WebhookReceiverRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookReceiver]
+    def webhook_receivers_create(x_account_token, webhook_receiver_request, opts = {})
+      data, _status_code, _headers = webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request, opts)
+      data
+    end
+
+    # Creates a `WebhookReceiver` object with the given values.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param webhook_receiver_request [WebhookReceiverRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookReceiver, Integer, Hash)>] WebhookReceiver data, response status code and response headers
+    def webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookReceiversApi.webhook_receivers_create ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling WebhookReceiversApi.webhook_receivers_create"
+      end
+      # verify the required parameter 'webhook_receiver_request' is set
+      if @api_client.config.client_side_validation && webhook_receiver_request.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_receiver_request' when calling WebhookReceiversApi.webhook_receivers_create"
+      end
+      # resource path
+      local_var_path = '/webhook-receivers'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      header_params[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_receiver_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebhookReceiver'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhookReceiversApi.webhook_receivers_create",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhookReceiversApi#webhook_receivers_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of `WebhookReceiver` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<WebhookReceiver>]
+    def webhook_receivers_list(x_account_token, opts = {})
+      data, _status_code, _headers = webhook_receivers_list_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns a list of &#x60;WebhookReceiver&#x60; objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<WebhookReceiver>, Integer, Hash)>] Array<WebhookReceiver> data, response status code and response headers
+    def webhook_receivers_list_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookReceiversApi.webhook_receivers_list ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling WebhookReceiversApi.webhook_receivers_list"
+      end
+      # resource path
+      local_var_path = '/webhook-receivers'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<WebhookReceiver>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhookReceiversApi.webhook_receivers_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: WebhookReceiversApi#webhook_receivers_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_hris_client/configuration.rb

@@ -197,11 +197,13 @@ module MergeHRISClient
 
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        "#{@api_key_prefix[param_name]} #{key}"
       else
-        @api_key[param_name]
+        key
       end
     end
 
@@ -218,7 +220,7 @@ module MergeHRISClient
             type: 'api_key',
             in: 'header',
             key: 'Authorization',
-            value: api_key_with_prefix('Authorization')
+            value: api_key_with_prefix('tokenAuth')
           },
       }
     end

data/lib/merge_hris_client/models/account_details.rb

@@ -19,6 +19,8 @@ module MergeHRISClient
 
     attr_accessor :integration
 
+    attr_accessor :integration_slug
+
     attr_accessor :category
 
     attr_accessor :end_user_origin_id
@@ -29,16 +31,20 @@ module MergeHRISClient
 
     attr_accessor :status
 
+    attr_accessor :webhook_listener_url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'integration' => :'integration',
+        :'integration_slug' => :'integration_slug',
         :'category' => :'category',
         :'end_user_origin_id' => :'end_user_origin_id',
         :'end_user_organization_name' => :'end_user_organization_name',
         :'end_user_email_address' => :'end_user_email_address',
-        :'status' => :'status'
+        :'status' => :'status',
+        :'webhook_listener_url' => :'webhook_listener_url'
       }
     end
 
@@ -52,11 +58,13 @@ module MergeHRISClient
       {
         :'id' => :'String',
         :'integration' => :'String',
+        :'integration_slug' => :'String',
         :'category' => :'CategoryEnum',
         :'end_user_origin_id' => :'String',
         :'end_user_organization_name' => :'String',
         :'end_user_email_address' => :'String',
-        :'status' => :'String'
+        :'status' => :'String',
+        :'webhook_listener_url' => :'String'
       }
     end
 
@@ -90,6 +98,10 @@ module MergeHRISClient
         self.integration = attributes[:'integration']
       end
 
+      if attributes.key?(:'integration_slug')
+        self.integration_slug = attributes[:'integration_slug']
+      end
+
       if attributes.key?(:'category')
         self.category = attributes[:'category']
       end
@@ -109,6 +121,10 @@ module MergeHRISClient
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
+
+      if attributes.key?(:'webhook_listener_url')
+        self.webhook_listener_url = attributes[:'webhook_listener_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -131,11 +147,13 @@ module MergeHRISClient
       self.class == o.class &&
           id == o.id &&
           integration == o.integration &&
+          integration_slug == o.integration_slug &&
           category == o.category &&
           end_user_origin_id == o.end_user_origin_id &&
           end_user_organization_name == o.end_user_organization_name &&
           end_user_email_address == o.end_user_email_address &&
-          status == o.status
+          status == o.status &&
+          webhook_listener_url == o.webhook_listener_url
     end
 
     # @see the `==` method
@@ -147,7 +165,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, integration, category, end_user_origin_id, end_user_organization_name, end_user_email_address, status].hash
+      [id, integration, integration_slug, category, end_user_origin_id, end_user_organization_name, end_user_email_address, status, webhook_listener_url].hash
     end
 
     # Builds the object from hash
@@ -190,7 +208,7 @@ module MergeHRISClient
       when :Date
         Date.parse(value)
       when :String
-        value.to_s
+        value
       when :Integer
         value.to_i
       when :Float

data/lib/merge_hris_client/models/account_details_and_actions.rb

@@ -30,6 +30,8 @@ module MergeHRISClient
 
     attr_accessor :end_user_email_address
 
+    attr_accessor :webhook_listener_url
+
     attr_accessor :integration
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -42,6 +44,7 @@ module MergeHRISClient
         :'end_user_origin_id' => :'end_user_origin_id',
         :'end_user_organization_name' => :'end_user_organization_name',
         :'end_user_email_address' => :'end_user_email_address',
+        :'webhook_listener_url' => :'webhook_listener_url',
         :'integration' => :'integration'
       }
     end
@@ -61,6 +64,7 @@ module MergeHRISClient
         :'end_user_origin_id' => :'String',
         :'end_user_organization_name' => :'String',
         :'end_user_email_address' => :'String',
+        :'webhook_listener_url' => :'String',
         :'integration' => :'AccountDetailsAndActionsIntegration'
       }
     end
@@ -114,6 +118,10 @@ module MergeHRISClient
         self.end_user_email_address = attributes[:'end_user_email_address']
       end
 
+      if attributes.key?(:'webhook_listener_url')
+        self.webhook_listener_url = attributes[:'webhook_listener_url']
+      end
+
       if attributes.key?(:'integration')
         self.integration = attributes[:'integration']
       end
@@ -139,6 +147,10 @@ module MergeHRISClient
         invalid_properties.push('invalid value for "end_user_email_address", end_user_email_address cannot be nil.')
       end
 
+      if @webhook_listener_url.nil?
+        invalid_properties.push('invalid value for "webhook_listener_url", webhook_listener_url cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -149,6 +161,7 @@ module MergeHRISClient
       return false if @status.nil?
       return false if @end_user_organization_name.nil?
       return false if @end_user_email_address.nil?
+      return false if @webhook_listener_url.nil?
       true
     end
 
@@ -164,6 +177,7 @@ module MergeHRISClient
           end_user_origin_id == o.end_user_origin_id &&
           end_user_organization_name == o.end_user_organization_name &&
           end_user_email_address == o.end_user_email_address &&
+          webhook_listener_url == o.webhook_listener_url &&
           integration == o.integration
     end
 
@@ -176,7 +190,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, category, status, status_detail, end_user_origin_id, end_user_organization_name, end_user_email_address, integration].hash
+      [id, category, status, status_detail, end_user_origin_id, end_user_organization_name, end_user_email_address, webhook_listener_url, integration].hash
     end
 
     # Builds the object from hash
@@ -219,7 +233,7 @@ module MergeHRISClient
       when :Date
         Date.parse(value)
       when :String
-        value.to_s
+        value
       when :Integer
         value.to_i
       when :Float

data/lib/merge_hris_client/models/account_details_and_actions_integration.rb

@@ -227,7 +227,7 @@ module MergeHRISClient
       when :Date
         Date.parse(value)
       when :String
-        value.to_s
+        value
       when :Integer
         value.to_i
       when :Float

data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb

@@ -33,4 +33,5 @@ module MergeHRISClient
       value
     end
   end
+
 end

data/lib/merge_hris_client/models/account_integration.rb

@@ -18,42 +18,20 @@ module MergeHRISClient
     # Company name.
     attr_accessor :name
 
-    # Category or categories this integration belongs to.
+    # Category or categories this integration belongs to. Multiple categories should be comma separated.<br/><br>Example: For [ats, hris], enter <i>ats,hris</i>
     attr_accessor :categories
 
-    # Company logo in rectangular shape.
+    # Company logo in rectangular shape. <b>Upload an image with a clear background.</b>
     attr_accessor :image
 
-    # Company logo in square shape.
+    # Company logo in square shape. <b>Upload an image with a white background.</b>
     attr_accessor :square_image
 
-    # The color of this integration used for buttons and text throughout the app and landing pages.
+    # The color of this integration used for buttons and text throughout the app and landing pages. <b>Choose a darker, saturated color.</b>
     attr_accessor :color
 
     attr_accessor :slug
 
-    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
       {
@@ -242,7 +220,7 @@ module MergeHRISClient
       when :Date
         Date.parse(value)
       when :String
-        value.to_s
+        value
       when :Integer
         value.to_i
       when :Float

data/lib/merge_hris_client/models/account_token.rb

@@ -154,7 +154,7 @@ module MergeHRISClient
       when :Date
         Date.parse(value)
       when :String
-        value.to_s
+        value
       when :Integer
         value.to_i
       when :Float

data/lib/merge_hris_client/models/account_type_enum.rb

@@ -32,4 +32,5 @@ module MergeHRISClient
       value
     end
   end
+
 end

data/lib/merge_hris_client/models/available_actions.rb

@@ -166,7 +166,7 @@ module MergeHRISClient
       when :Date
         Date.parse(value)
       when :String
-        value.to_s
+        value
       when :Integer
         value.to_i
       when :Float

data/lib/merge_hris_client/models/bank_info.rb

@@ -21,7 +21,6 @@ module MergeHRISClient
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
-    # The employee with this bank account.
     attr_accessor :employee
 
     # The account number.

data/lib/merge_hris_client/models/benefit.rb

@@ -21,7 +21,6 @@ module MergeHRISClient
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
-    # The employee on the plan.
     attr_accessor :employee
 
     # The name of the benefit provider.
@@ -64,7 +63,7 @@ module MergeHRISClient
         :'remote_id' => :'String',
         :'employee' => :'String',
         :'provider_name' => :'String',
-        :'benefit_plan_type' => :'BenefitPlanTypeEnum',
+        :'benefit_plan_type' => :'String',
         :'employee_contribution' => :'Float',
         :'company_contribution' => :'Float',
         :'remote_data' => :'Array<RemoteData>'

data/lib/merge_hris_client/models/categories_enum.rb

@@ -33,4 +33,5 @@ module MergeHRISClient
       value
     end
   end
+
 end

data/lib/merge_hris_client/models/category_enum.rb

@@ -33,4 +33,5 @@ module MergeHRISClient
       value
     end
   end
+
 end

data/lib/merge_hris_client/models/company.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The Company Object ### Description The `Company` object is used to represent a Company.  ### Usage Example Fetch from the `LIST Companies` endpoint and filter by `ID` to show all companies.
+  # # The Company Object ### Description The `Company` object is used to represent a Company within the HRIS / Payroll system.  ### Usage Example Fetch from the `LIST Companies` endpoint and filter by `ID` to show all companies.
   class Company
     attr_accessor :id
 

data/lib/merge_hris_client/models/country_enum.rb

@@ -279,4 +279,5 @@ module MergeHRISClient
       value
     end
   end
+
 end