ultracart_api 4.1.18 → 4.1.20

data/lib/ultracart_api/api/datawarehouse_api.rb

@@ -96,6 +96,76 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Delete a custom dashboard schedule
+    # delete a custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_schedule_oid [Integer] The dashboard schedule oid to delete.
+    # @param custom_dashboard_oid [Integer] The dashboard oid that owns the schedule.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, opts = {})
+      delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, opts)
+      nil
+    end
+
+    # Delete a custom dashboard schedule
+    # delete a custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_schedule_oid [Integer] The dashboard schedule oid to delete.
+    # @param custom_dashboard_oid [Integer] The dashboard oid that owns the schedule.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_custom_dashboard_schedule ...'
+      end
+      # verify the required parameter 'custom_dashboard_schedule_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_schedule_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_schedule_oid' when calling DatawarehouseApi.delete_custom_dashboard_schedule"
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.delete_custom_dashboard_schedule"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}'.sub('{' + 'custom_dashboard_schedule_oid' + '}', CGI.escape(custom_dashboard_schedule_oid.to_s)).sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"DatawarehouseApi.delete_custom_dashboard_schedule",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#delete_custom_dashboard_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete a custom report
     # Delete a custom report on the UltraCart account. 
     # @param custom_report_oid [Integer] The report oid to delete.
@@ -570,6 +640,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get custom dashboards
+    # Retrieve a custom dashboards 
+    # @param custom_dashboard_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardSchedulesResponse]
+    def get_custom_dashboard_schedules(custom_dashboard_oid, opts = {})
+      data, _status_code, _headers = get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid, opts)
+      data
+    end
+
+    # Get custom dashboards
+    # Retrieve a custom dashboards 
+    # @param custom_dashboard_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardSchedulesResponse, Integer, Hash)>] CustomDashboardSchedulesResponse data, response status code and response headers
+    def get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_dashboard_schedules ...'
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.get_custom_dashboard_schedules"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules'.sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CustomDashboardSchedulesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"DatawarehouseApi.get_custom_dashboard_schedules",
+        :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: DatawarehouseApi#get_custom_dashboard_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get custom dashboards
     # Retrieve a custom dashboards 
     # @param [Hash] opts the optional parameters
@@ -1191,6 +1325,81 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Create a custom dashboard schedule
+    # Create a new custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_oid [Integer] 
+    # @param dashboard_schedule [CustomDashboardSchedule] Dashboard schedule to create
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardScheduleResponse]
+    def insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule, opts = {})
+      data, _status_code, _headers = insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule, opts)
+      data
+    end
+
+    # Create a custom dashboard schedule
+    # Create a new custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_oid [Integer] 
+    # @param dashboard_schedule [CustomDashboardSchedule] Dashboard schedule to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardScheduleResponse, Integer, Hash)>] CustomDashboardScheduleResponse data, response status code and response headers
+    def insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_custom_dashboard_schedule ...'
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.insert_custom_dashboard_schedule"
+      end
+      # verify the required parameter 'dashboard_schedule' is set
+      if @api_client.config.client_side_validation && dashboard_schedule.nil?
+        fail ArgumentError, "Missing the required parameter 'dashboard_schedule' when calling DatawarehouseApi.insert_custom_dashboard_schedule"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules'.sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard_schedule)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CustomDashboardScheduleResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"DatawarehouseApi.insert_custom_dashboard_schedule",
+        :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: DatawarehouseApi#insert_custom_dashboard_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a custom report
     # Create a new custom report on the UltraCart account. 
     # @param report [CustomReport] Report to create
@@ -1404,6 +1613,87 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Update a custom dashboard schedule
+    # Update a custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_schedule_oid [Integer] The dashboard schedule oid to update.
+    # @param custom_dashboard_oid [Integer] The dashboard oid to update.
+    # @param dashboard_schedule [CustomDashboardSchedule] Dashboard schedule to update
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardResponse]
+    def update_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule, opts = {})
+      data, _status_code, _headers = update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule, opts)
+      data
+    end
+
+    # Update a custom dashboard schedule
+    # Update a custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_schedule_oid [Integer] The dashboard schedule oid to update.
+    # @param custom_dashboard_oid [Integer] The dashboard oid to update.
+    # @param dashboard_schedule [CustomDashboardSchedule] Dashboard schedule to update
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardResponse, Integer, Hash)>] CustomDashboardResponse data, response status code and response headers
+    def update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_dashboard_schedule ...'
+      end
+      # verify the required parameter 'custom_dashboard_schedule_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_schedule_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_schedule_oid' when calling DatawarehouseApi.update_custom_dashboard_schedule"
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.update_custom_dashboard_schedule"
+      end
+      # verify the required parameter 'dashboard_schedule' is set
+      if @api_client.config.client_side_validation && dashboard_schedule.nil?
+        fail ArgumentError, "Missing the required parameter 'dashboard_schedule' when calling DatawarehouseApi.update_custom_dashboard_schedule"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}'.sub('{' + 'custom_dashboard_schedule_oid' + '}', CGI.escape(custom_dashboard_schedule_oid.to_s)).sub('{' + 'custom_dashboard_oid' + '}', CGI.escape(custom_dashboard_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard_schedule)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CustomDashboardResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"DatawarehouseApi.update_custom_dashboard_schedule",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_dashboard_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a custom report
     # Update a custom report on the UltraCart account. 
     # @param custom_report_oid [Integer] The report oid to custom update.

data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb

@@ -31,6 +31,9 @@ module UltracartClient
     # Email to send support ticket to
     attr_accessor :open_support_ticket_channel_email
 
+    # Department ID to open a Zoho Desk ticket for
+    attr_accessor :open_support_ticket_zoho_desk_department_id
+
     attr_accessor :pause_subscription
 
     attr_accessor :resume_subscription
@@ -39,6 +42,12 @@ module UltracartClient
 
     attr_accessor :update_subscription_credit_card
 
+    # True if Zoho Desk is connected to UltraCart
+    attr_accessor :zoho_desk_available
+
+    # Array of Zoho Desk Department if zoho desk is connected to UltraCart
+    attr_accessor :zoho_desk_departments
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -71,10 +80,13 @@ module UltracartClient
         :'open_support_ticket' => :'open_support_ticket',
         :'open_support_ticket_channel' => :'open_support_ticket_channel',
         :'open_support_ticket_channel_email' => :'open_support_ticket_channel_email',
+        :'open_support_ticket_zoho_desk_department_id' => :'open_support_ticket_zoho_desk_department_id',
         :'pause_subscription' => :'pause_subscription',
         :'resume_subscription' => :'resume_subscription',
         :'transfer_chat_to_live_agent' => :'transfer_chat_to_live_agent',
-        :'update_subscription_credit_card' => :'update_subscription_credit_card'
+        :'update_subscription_credit_card' => :'update_subscription_credit_card',
+        :'zoho_desk_available' => :'zoho_desk_available',
+        :'zoho_desk_departments' => :'zoho_desk_departments'
       }
     end
 
@@ -93,10 +105,13 @@ module UltracartClient
         :'open_support_ticket' => :'Boolean',
         :'open_support_ticket_channel' => :'String',
         :'open_support_ticket_channel_email' => :'String',
+        :'open_support_ticket_zoho_desk_department_id' => :'String',
         :'pause_subscription' => :'Boolean',
         :'resume_subscription' => :'Boolean',
         :'transfer_chat_to_live_agent' => :'Boolean',
-        :'update_subscription_credit_card' => :'Boolean'
+        :'update_subscription_credit_card' => :'Boolean',
+        :'zoho_desk_available' => :'Boolean',
+        :'zoho_desk_departments' => :'Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>'
       }
     end
 
@@ -149,6 +164,10 @@ module UltracartClient
         self.open_support_ticket_channel_email = attributes[:'open_support_ticket_channel_email']
       end
 
+      if attributes.key?(:'open_support_ticket_zoho_desk_department_id')
+        self.open_support_ticket_zoho_desk_department_id = attributes[:'open_support_ticket_zoho_desk_department_id']
+      end
+
       if attributes.key?(:'pause_subscription')
         self.pause_subscription = attributes[:'pause_subscription']
       end
@@ -164,6 +183,16 @@ module UltracartClient
       if attributes.key?(:'update_subscription_credit_card')
         self.update_subscription_credit_card = attributes[:'update_subscription_credit_card']
       end
+
+      if attributes.key?(:'zoho_desk_available')
+        self.zoho_desk_available = attributes[:'zoho_desk_available']
+      end
+
+      if attributes.key?(:'zoho_desk_departments')
+        if (value = attributes[:'zoho_desk_departments']).is_a?(Array)
+          self.zoho_desk_departments = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -176,7 +205,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      open_support_ticket_channel_validator = EnumAttributeValidator.new('String', ["none", "email", "UltraCart Task", "Zoho Desk Ticket"])
+      open_support_ticket_channel_validator = EnumAttributeValidator.new('String', ["none", "email", "ultracart_task", "zoho_desk_ticket"])
       return false unless open_support_ticket_channel_validator.valid?(@open_support_ticket_channel)
       true
     end
@@ -184,7 +213,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] open_support_ticket_channel Object to be assigned
     def open_support_ticket_channel=(open_support_ticket_channel)
-      validator = EnumAttributeValidator.new('String', ["none", "email", "UltraCart Task", "Zoho Desk Ticket"])
+      validator = EnumAttributeValidator.new('String', ["none", "email", "ultracart_task", "zoho_desk_ticket"])
       unless validator.valid?(open_support_ticket_channel)
         fail ArgumentError, "invalid value for \"open_support_ticket_channel\", must be one of #{validator.allowable_values}."
       end
@@ -203,10 +232,13 @@ module UltracartClient
           open_support_ticket == o.open_support_ticket &&
           open_support_ticket_channel == o.open_support_ticket_channel &&
           open_support_ticket_channel_email == o.open_support_ticket_channel_email &&
+          open_support_ticket_zoho_desk_department_id == o.open_support_ticket_zoho_desk_department_id &&
           pause_subscription == o.pause_subscription &&
           resume_subscription == o.resume_subscription &&
           transfer_chat_to_live_agent == o.transfer_chat_to_live_agent &&
-          update_subscription_credit_card == o.update_subscription_credit_card
+          update_subscription_credit_card == o.update_subscription_credit_card &&
+          zoho_desk_available == o.zoho_desk_available &&
+          zoho_desk_departments == o.zoho_desk_departments
     end
 
     # @see the `==` method
@@ -218,7 +250,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [cancel_subscription, delay_subscription, lookup_order_information, lookup_subscription_information, open_support_ticket, open_support_ticket_channel, open_support_ticket_channel_email, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card].hash
+      [cancel_subscription, delay_subscription, lookup_order_information, lookup_subscription_information, open_support_ticket, open_support_ticket_channel, open_support_ticket_channel_email, open_support_ticket_zoho_desk_department_id, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card, zoho_desk_available, zoho_desk_departments].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb

@@ -0,0 +1,228 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class ConversationVirtualAgentCapabilityZohoDeskDepartment
+    attr_accessor :department_id
+
+    attr_accessor :department_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'department_id' => :'department_id',
+        :'department_name' => :'department_name'
+      }
+    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
+      {
+        :'department_id' => :'String',
+        :'department_name' => :'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 `UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment` 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 `UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment`. 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?(:'department_id')
+        self.department_id = attributes[:'department_id']
+      end
+
+      if attributes.key?(:'department_name')
+        self.department_name = attributes[:'department_name']
+      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
+      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?
+      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 &&
+          department_id == o.department_id &&
+          department_name == o.department_name
+    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
+      [department_id, department_name].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 = UltracartClient.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