purecloud 0.67.1 → 0.68.1

data/lib/purecloud/api/quality_api.rb

@@ -1143,6 +1143,7 @@ module PureCloud
     # @option opts [String] :name the keyword set name - used for filtering results in searches.
     # @option opts [String] :queue_id the queue id - used for filtering results in searches.
     # @option opts [String] :agent_id the agent id - used for filtering results in searches.
+    # @option opts [String] :operator If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
     # @return [KeywordSetEntityListing]
     def get_keywordsets(opts = {})
       data, status_code, headers = get_keywordsets_with_http_info(opts)
@@ -1161,12 +1162,17 @@ module PureCloud
     # @option opts [String] :name the keyword set name - used for filtering results in searches.
     # @option opts [String] :queue_id the queue id - used for filtering results in searches.
     # @option opts [String] :agent_id the agent id - used for filtering results in searches.
+    # @option opts [String] :operator If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
     # @return [Array<(KeywordSetEntityListing, Fixnum, Hash)>] KeywordSetEntityListing data, response status code and response headers
     def get_keywordsets_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: QualityApi#get_keywordsets ..."
       end
       
+      if opts[:'operator'] && !['AND', 'OR'].include?(opts[:'operator'])
+        fail 'invalid value for "operator", must be one of AND, OR'
+      end
+      
       # resource path
       local_var_path = "/api/v2/quality/keywordsets".sub('{format}','json')
 
@@ -1181,6 +1187,7 @@ module PureCloud
       query_params[:'name'] = opts[:'name'] if opts[:'name']
       query_params[:'queueId'] = opts[:'queue_id'] if opts[:'queue_id']
       query_params[:'agentId'] = opts[:'agent_id'] if opts[:'agent_id']
+      query_params[:'operator'] = opts[:'operator'] if opts[:'operator']
 
       # header parameters
       header_params = {}

data/lib/purecloud/api/telephony_providers_edge_api.rb

@@ -5470,6 +5470,7 @@ module PureCloud
     # 
     # @param edge_id Edge ID
     # @param [Hash] opts the optional parameters
+    # @option opts [EdgeRebootParameters] :body Parameters for the edge reboot
     # @return [String]
     def post_providers_edges_edge_id_reboot(edge_id, opts = {})
       data, status_code, headers = post_providers_edges_edge_id_reboot_with_http_info(edge_id, opts)
@@ -5480,6 +5481,7 @@ module PureCloud
     # 
     # @param edge_id Edge ID
     # @param [Hash] opts the optional parameters
+    # @option opts [EdgeRebootParameters] :body Parameters for the edge reboot
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def post_providers_edges_edge_id_reboot_with_http_info(edge_id, opts = {})
       if @api_client.config.debugging
@@ -5510,7 +5512,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = nil
+      post_body = @api_client.object_to_http_body(opts[:'body'])
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,

data/lib/purecloud/api/workforce_management_api.rb

@@ -148,6 +148,126 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get activity codes corresponding to a management unit
+    # 
+    # @param mu_id The muId of the management unit.
+    # @param [Hash] opts the optional parameters
+    # @return [ActivityCodeContainer]
+    def get_managementunits_mu_id_activitycodes(mu_id, opts = {})
+      data, status_code, headers = get_managementunits_mu_id_activitycodes_with_http_info(mu_id, opts)
+      return data
+    end
+
+    # Get activity codes corresponding to a management unit
+    # 
+    # @param mu_id The muId of the management unit.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivityCodeContainer, Fixnum, Hash)>] ActivityCodeContainer data, response status code and response headers
+    def get_managementunits_mu_id_activitycodes_with_http_info(mu_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WorkforceManagementApi#get_managementunits_mu_id_activitycodes ..."
+      end
+      
+      # verify the required parameter 'mu_id' is set
+      fail "Missing the required parameter 'mu_id' when calling get_managementunits_mu_id_activitycodes" if mu_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/activitycodes".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # 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 = ['PureCloud Auth']
+      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 => 'ActivityCodeContainer')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkforceManagementApi#get_managementunits_mu_id_activitycodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get agents in the management unit
+    # 
+    # @param mu_id The muId of the management unit.
+    # @param [Hash] opts the optional parameters
+    # @return [WfmUserEntityListing]
+    def get_managementunits_mu_id_users(mu_id, opts = {})
+      data, status_code, headers = get_managementunits_mu_id_users_with_http_info(mu_id, opts)
+      return data
+    end
+
+    # Get agents in the management unit
+    # 
+    # @param mu_id The muId of the management unit.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WfmUserEntityListing, Fixnum, Hash)>] WfmUserEntityListing data, response status code and response headers
+    def get_managementunits_mu_id_users_with_http_info(mu_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WorkforceManagementApi#get_managementunits_mu_id_users ..."
+      end
+      
+      # verify the required parameter 'mu_id' is set
+      fail "Missing the required parameter 'mu_id' when calling get_managementunits_mu_id_users" if mu_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # 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 = ['PureCloud Auth']
+      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 => 'WfmUserEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkforceManagementApi#get_managementunits_mu_id_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a list of time off requests for any user
     # 
     # @param mu_id The muId of the management unit.
@@ -585,11 +705,73 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get user schedules within the given time range
+    # 
+    # @param mu_id The muId of the management unit.
+    # @param [Hash] opts the optional parameters
+    # @option opts [UserListScheduleRequestBody] :body body
+    # @return [UserScheduleContainer]
+    def post_managementunits_mu_id_schedules_search(mu_id, opts = {})
+      data, status_code, headers = post_managementunits_mu_id_schedules_search_with_http_info(mu_id, opts)
+      return data
+    end
+
+    # Get user schedules within the given time range
+    # 
+    # @param mu_id The muId of the management unit.
+    # @param [Hash] opts the optional parameters
+    # @option opts [UserListScheduleRequestBody] :body body
+    # @return [Array<(UserScheduleContainer, Fixnum, Hash)>] UserScheduleContainer data, response status code and response headers
+    def post_managementunits_mu_id_schedules_search_with_http_info(mu_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WorkforceManagementApi#post_managementunits_mu_id_schedules_search ..."
+      end
+      
+      # verify the required parameter 'mu_id' is set
+      fail "Missing the required parameter 'mu_id' when calling post_managementunits_mu_id_schedules_search" if mu_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/schedules/search".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # 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 = @api_client.object_to_http_body(opts[:'body'])
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'UserScheduleContainer')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkforceManagementApi#post_managementunits_mu_id_schedules_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a schedule for the current user
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [CurrentUserScheduleRequestBody] :body body
-    # @return [TimeOffRequestList]
+    # @return [UserScheduleContainer]
     def post_schedules(opts = {})
       data, status_code, headers = post_schedules_with_http_info(opts)
       return data
@@ -599,7 +781,7 @@ module PureCloud
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [CurrentUserScheduleRequestBody] :body body
-    # @return [Array<(TimeOffRequestList, Fixnum, Hash)>] TimeOffRequestList data, response status code and response headers
+    # @return [Array<(UserScheduleContainer, Fixnum, Hash)>] UserScheduleContainer data, response status code and response headers
     def post_schedules_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: WorkforceManagementApi#post_schedules ..."
@@ -635,7 +817,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'TimeOffRequestList')
+        :return_type => 'UserScheduleContainer')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: WorkforceManagementApi#post_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/purecloud/api_client.rb

@@ -33,7 +33,7 @@ module PureCloud
 
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "PureCloud SDK/Ruby 0.67.1"
+      @user_agent = "PureCloud SDK/Ruby 0.68.1"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

data/lib/purecloud/models/activity_code.rb

@@ -0,0 +1,253 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@inin.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  # Activity code data
+  class ActivityCode
+    # The activity code's name
+    attr_accessor :name
+
+    # Whether this activity code is active or only used for historical schedules
+    attr_accessor :is_active
+
+    # Whether this is a default activity code
+    attr_accessor :is_default
+
+    # The activity code's category
+    attr_accessor :category
+
+    # The default length of the activity in minutes
+    attr_accessor :length_in_minutes
+
+    # Whether an agent is paid while performing this activity
+    attr_accessor :counts_as_paid_time
+
+    # Indicates whether or not the activity should be counted as work time
+    attr_accessor :counts_as_work_time
+
+    # Whether an agent can select this activity code when creating or editing a time off request
+    attr_accessor :is_agent_time_off_selectable
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'name' => :'name',
+        
+        :'is_active' => :'isActive',
+        
+        :'is_default' => :'isDefault',
+        
+        :'category' => :'category',
+        
+        :'length_in_minutes' => :'lengthInMinutes',
+        
+        :'counts_as_paid_time' => :'countsAsPaidTime',
+        
+        :'counts_as_work_time' => :'countsAsWorkTime',
+        
+        :'is_agent_time_off_selectable' => :'isAgentTimeOffSelectable'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'is_active' => :'BOOLEAN',
+        :'is_default' => :'BOOLEAN',
+        :'category' => :'String',
+        :'length_in_minutes' => :'Integer',
+        :'counts_as_paid_time' => :'BOOLEAN',
+        :'counts_as_work_time' => :'BOOLEAN',
+        :'is_agent_time_off_selectable' => :'BOOLEAN'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'name']
+        self.name = attributes[:'name']
+      end
+      
+      if attributes[:'isActive']
+        self.is_active = attributes[:'isActive']
+      end
+      
+      if attributes[:'isDefault']
+        self.is_default = attributes[:'isDefault']
+      end
+      
+      if attributes[:'category']
+        self.category = attributes[:'category']
+      end
+      
+      if attributes[:'lengthInMinutes']
+        self.length_in_minutes = attributes[:'lengthInMinutes']
+      end
+      
+      if attributes[:'countsAsPaidTime']
+        self.counts_as_paid_time = attributes[:'countsAsPaidTime']
+      end
+      
+      if attributes[:'countsAsWorkTime']
+        self.counts_as_work_time = attributes[:'countsAsWorkTime']
+      end
+      
+      if attributes[:'isAgentTimeOffSelectable']
+        self.is_agent_time_off_selectable = attributes[:'isAgentTimeOffSelectable']
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def category=(category)
+      allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable"]
+      if category && !allowed_values.include?(category)
+        fail "invalid value for 'category', must be one of #{allowed_values}"
+      end
+      @category = category
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          is_active == o.is_active &&
+          is_default == o.is_default &&
+          category == o.category &&
+          length_in_minutes == o.length_in_minutes &&
+          counts_as_paid_time == o.counts_as_paid_time &&
+          counts_as_work_time == o.counts_as_work_time &&
+          is_agent_time_off_selectable == o.is_agent_time_off_selectable
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [name, is_active, is_default, category, length_in_minutes, counts_as_paid_time, counts_as_work_time, is_agent_time_off_selectable].hash
+    end
+
+    # build the object from hash
+    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
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    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
+        _model = Object.const_get("PureCloud").const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return 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
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    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