purecloud 0.66.1 → 0.67.1

data/lib/purecloud/api/organization_api.rb

@@ -46,8 +46,8 @@ module PureCloud
       
       # verify the required parameter 'type' is set
       fail "Missing the required parameter 'type' when calling get_fieldconfig" if type.nil?
-      unless ['person', 'group', 'org'].include?(type)
-        fail "invalid value for 'type', must be one of person, group, org"
+      unless ['person', 'group', 'org', 'externalContact'].include?(type)
+        fail "invalid value for 'type', must be one of person, group, org, externalContact"
       end
       
       # resource path

data/lib/purecloud/api/outbound_api.rb

@@ -328,17 +328,17 @@ module PureCloud
     # 
     # @param campaign_id Campaign ID
     # @param [Hash] opts the optional parameters
-    # @return [String]
+    # @return [nil]
     def delete_campaigns_campaign_id_progress(campaign_id, opts = {})
-      data, status_code, headers = delete_campaigns_campaign_id_progress_with_http_info(campaign_id, opts)
-      return data
+      delete_campaigns_campaign_id_progress_with_http_info(campaign_id, opts)
+      return nil
     end
 
     # Reset campaign progress and recycle the campaign
     # 
     # @param campaign_id Campaign ID
     # @param [Hash] opts the optional parameters
-    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def delete_campaigns_campaign_id_progress_with_http_info(campaign_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: OutboundApi#delete_campaigns_campaign_id_progress ..."
@@ -376,8 +376,7 @@ module PureCloud
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'String')
+        :auth_names => auth_names)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: OutboundApi#delete_campaigns_campaign_id_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/purecloud/api/telephony_providers_edge_api.rb

@@ -1758,6 +1758,66 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get the edge metrics.
+    # 
+    # @param edge_id Edge Id
+    # @param [Hash] opts the optional parameters
+    # @return [EdgeMetrics]
+    def get_providers_edges_edge_id_metrics(edge_id, opts = {})
+      data, status_code, headers = get_providers_edges_edge_id_metrics_with_http_info(edge_id, opts)
+      return data
+    end
+
+    # Get the edge metrics.
+    # 
+    # @param edge_id Edge Id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EdgeMetrics, Fixnum, Hash)>] EdgeMetrics data, response status code and response headers
+    def get_providers_edges_edge_id_metrics_with_http_info(edge_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_metrics ..."
+      end
+      
+      # verify the required parameter 'edge_id' is set
+      fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_metrics" if edge_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/telephony/providers/edges/{edgeId}/metrics".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_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 => 'EdgeMetrics')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve a list of all configured physical interfaces from a specific edge.
     # 
     # @param edge_id Edge ID
@@ -2953,6 +3013,67 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get the metrics for a list of edges.
+    # 
+    # @param edge_ids Comma separated list of Edge Id&#39;s
+    # @param [Hash] opts the optional parameters
+    # @return [Array<EdgeMetrics>]
+    def get_providers_edges_metrics(edge_ids, opts = {})
+      data, status_code, headers = get_providers_edges_metrics_with_http_info(edge_ids, opts)
+      return data
+    end
+
+    # Get the metrics for a list of edges.
+    # 
+    # @param edge_ids Comma separated list of Edge Id&#39;s
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<EdgeMetrics>, Fixnum, Hash)>] Array<EdgeMetrics> data, response status code and response headers
+    def get_providers_edges_metrics_with_http_info(edge_ids, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_metrics ..."
+      end
+      
+      # verify the required parameter 'edge_ids' is set
+      fail "Missing the required parameter 'edge_ids' when calling get_providers_edges_metrics" if edge_ids.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/telephony/providers/edges/metrics".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'edgeIds'] = edge_ids
+
+      # 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 => 'Array<EdgeMetrics>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get outbound routes
     # 
     # @param [Hash] opts the optional parameters
@@ -3090,6 +3211,7 @@ module PureCloud
     # @option opts [Integer] :page_size Page size (default to 25)
     # @option opts [String] :sort_by Value by which to sort (default to name)
     # @option opts [String] :sort_order Sort order (default to ASC)
+    # @option opts [String] :name Name
     # @return [PhoneBaseEntityListing]
     def get_providers_edges_phonebasesettings(opts = {})
       data, status_code, headers = get_providers_edges_phonebasesettings_with_http_info(opts)
@@ -3103,6 +3225,7 @@ module PureCloud
     # @option opts [Integer] :page_size Page size
     # @option opts [String] :sort_by Value by which to sort
     # @option opts [String] :sort_order Sort order
+    # @option opts [String] :name Name
     # @return [Array<(PhoneBaseEntityListing, Fixnum, Hash)>] PhoneBaseEntityListing data, response status code and response headers
     def get_providers_edges_phonebasesettings_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -3118,6 +3241,7 @@ module PureCloud
       query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
       query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+      query_params[:'name'] = opts[:'name'] if opts[:'name']
 
       # header parameters
       header_params = {}

data/lib/purecloud/api/users_api.rb

@@ -348,8 +348,8 @@ module PureCloud
       
       # verify the required parameter 'type' is set
       fail "Missing the required parameter 'type' when calling get_fieldconfig" if type.nil?
-      unless ['person', 'group', 'org'].include?(type)
-        fail "invalid value for 'type', must be one of person, group, org"
+      unless ['person', 'group', 'org', 'externalContact'].include?(type)
+        fail "invalid value for 'type', must be one of person, group, org, externalContact"
       end
       
       # resource path

data/lib/purecloud/api/workforce_management_api.rb

@@ -26,9 +26,9 @@ module PureCloud
 
     # Get a list of UserScheduleAdherence records for the requested users
     # 
-    # @param user_id User Id(s) for which to fetch current schedule adherence information.  Max of 100 userIds per request
+    # @param user_id User Id(s) for which to fetch current schedule adherence information.  Min 1, Max of 100 userIds per request
     # @param [Hash] opts the optional parameters
-    # @return [UserScheduleAdherence]
+    # @return [Array<UserScheduleAdherence>]
     def get_adherence(user_id, opts = {})
       data, status_code, headers = get_adherence_with_http_info(user_id, opts)
       return data
@@ -36,9 +36,9 @@ module PureCloud
 
     # Get a list of UserScheduleAdherence records for the requested users
     # 
-    # @param user_id User Id(s) for which to fetch current schedule adherence information.  Max of 100 userIds per request
+    # @param user_id User Id(s) for which to fetch current schedule adherence information.  Min 1, Max of 100 userIds per request
     # @param [Hash] opts the optional parameters
-    # @return [Array<(UserScheduleAdherence, Fixnum, Hash)>] UserScheduleAdherence data, response status code and response headers
+    # @return [Array<(Array<UserScheduleAdherence>, Fixnum, Hash)>] Array<UserScheduleAdherence> data, response status code and response headers
     def get_adherence_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: WorkforceManagementApi#get_adherence ..."
@@ -78,7 +78,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'UserScheduleAdherence')
+        :return_type => 'Array<UserScheduleAdherence>')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: WorkforceManagementApi#get_adherence\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.66.1"
+      @user_agent = "PureCloud SDK/Ruby 0.67.1"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

data/lib/purecloud/models/agent_activity_entity_listing.rb

@@ -26,15 +26,15 @@ module PureCloud
 
     attr_accessor :total
 
-    attr_accessor :self_uri
-
     attr_accessor :first_uri
 
-    attr_accessor :next_uri
+    attr_accessor :self_uri
+
+    attr_accessor :previous_uri
 
     attr_accessor :last_uri
 
-    attr_accessor :previous_uri
+    attr_accessor :next_uri
 
     attr_accessor :page_count
 
@@ -50,15 +50,15 @@ module PureCloud
         
         :'total' => :'total',
         
-        :'self_uri' => :'selfUri',
-        
         :'first_uri' => :'firstUri',
         
-        :'next_uri' => :'nextUri',
+        :'self_uri' => :'selfUri',
+        
+        :'previous_uri' => :'previousUri',
         
         :'last_uri' => :'lastUri',
         
-        :'previous_uri' => :'previousUri',
+        :'next_uri' => :'nextUri',
         
         :'page_count' => :'pageCount'
         
@@ -72,11 +72,11 @@ module PureCloud
         :'page_size' => :'Integer',
         :'page_number' => :'Integer',
         :'total' => :'Integer',
-        :'self_uri' => :'String',
         :'first_uri' => :'String',
-        :'next_uri' => :'String',
-        :'last_uri' => :'String',
+        :'self_uri' => :'String',
         :'previous_uri' => :'String',
+        :'last_uri' => :'String',
+        :'next_uri' => :'String',
         :'page_count' => :'Integer'
         
       }
@@ -107,24 +107,24 @@ module PureCloud
         self.total = attributes[:'total']
       end
       
-      if attributes[:'selfUri']
-        self.self_uri = attributes[:'selfUri']
-      end
-      
       if attributes[:'firstUri']
         self.first_uri = attributes[:'firstUri']
       end
       
-      if attributes[:'nextUri']
-        self.next_uri = attributes[:'nextUri']
+      if attributes[:'selfUri']
+        self.self_uri = attributes[:'selfUri']
+      end
+      
+      if attributes[:'previousUri']
+        self.previous_uri = attributes[:'previousUri']
       end
       
       if attributes[:'lastUri']
         self.last_uri = attributes[:'lastUri']
       end
       
-      if attributes[:'previousUri']
-        self.previous_uri = attributes[:'previousUri']
+      if attributes[:'nextUri']
+        self.next_uri = attributes[:'nextUri']
       end
       
       if attributes[:'pageCount']
@@ -141,11 +141,11 @@ module PureCloud
           page_size == o.page_size &&
           page_number == o.page_number &&
           total == o.total &&
-          self_uri == o.self_uri &&
           first_uri == o.first_uri &&
-          next_uri == o.next_uri &&
-          last_uri == o.last_uri &&
+          self_uri == o.self_uri &&
           previous_uri == o.previous_uri &&
+          last_uri == o.last_uri &&
+          next_uri == o.next_uri &&
           page_count == o.page_count
     end
 
@@ -156,7 +156,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [entities, page_size, page_number, total, self_uri, first_uri, next_uri, last_uri, previous_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, self_uri, previous_uri, last_uri, next_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/attempt_limits_entity_listing.rb

@@ -26,15 +26,15 @@ module PureCloud
 
     attr_accessor :total
 
-    attr_accessor :self_uri
-
     attr_accessor :first_uri
 
-    attr_accessor :next_uri
+    attr_accessor :self_uri
+
+    attr_accessor :previous_uri
 
     attr_accessor :last_uri
 
-    attr_accessor :previous_uri
+    attr_accessor :next_uri
 
     attr_accessor :page_count
 
@@ -50,15 +50,15 @@ module PureCloud
         
         :'total' => :'total',
         
-        :'self_uri' => :'selfUri',
-        
         :'first_uri' => :'firstUri',
         
-        :'next_uri' => :'nextUri',
+        :'self_uri' => :'selfUri',
+        
+        :'previous_uri' => :'previousUri',
         
         :'last_uri' => :'lastUri',
         
-        :'previous_uri' => :'previousUri',
+        :'next_uri' => :'nextUri',
         
         :'page_count' => :'pageCount'
         
@@ -72,11 +72,11 @@ module PureCloud
         :'page_size' => :'Integer',
         :'page_number' => :'Integer',
         :'total' => :'Integer',
-        :'self_uri' => :'String',
         :'first_uri' => :'String',
-        :'next_uri' => :'String',
-        :'last_uri' => :'String',
+        :'self_uri' => :'String',
         :'previous_uri' => :'String',
+        :'last_uri' => :'String',
+        :'next_uri' => :'String',
         :'page_count' => :'Integer'
         
       }
@@ -107,24 +107,24 @@ module PureCloud
         self.total = attributes[:'total']
       end
       
-      if attributes[:'selfUri']
-        self.self_uri = attributes[:'selfUri']
-      end
-      
       if attributes[:'firstUri']
         self.first_uri = attributes[:'firstUri']
       end
       
-      if attributes[:'nextUri']
-        self.next_uri = attributes[:'nextUri']
+      if attributes[:'selfUri']
+        self.self_uri = attributes[:'selfUri']
+      end
+      
+      if attributes[:'previousUri']
+        self.previous_uri = attributes[:'previousUri']
       end
       
       if attributes[:'lastUri']
         self.last_uri = attributes[:'lastUri']
       end
       
-      if attributes[:'previousUri']
-        self.previous_uri = attributes[:'previousUri']
+      if attributes[:'nextUri']
+        self.next_uri = attributes[:'nextUri']
       end
       
       if attributes[:'pageCount']
@@ -141,11 +141,11 @@ module PureCloud
           page_size == o.page_size &&
           page_number == o.page_number &&
           total == o.total &&
-          self_uri == o.self_uri &&
           first_uri == o.first_uri &&
-          next_uri == o.next_uri &&
-          last_uri == o.last_uri &&
+          self_uri == o.self_uri &&
           previous_uri == o.previous_uri &&
+          last_uri == o.last_uri &&
+          next_uri == o.next_uri &&
           page_count == o.page_count
     end
 
@@ -156,7 +156,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [entities, page_size, page_number, total, self_uri, first_uri, next_uri, last_uri, previous_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, self_uri, previous_uri, last_uri, next_uri, page_count].hash
     end
 
     # build the object from hash