purecloudplatformclientv2 12.0.0 → 13.0.0

data/lib/purecloudplatformclientv2/api/architect_api.rb

@@ -2067,6 +2067,130 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get generated flow history
+    # 
+    # @param flow_id Flow ID
+    # @param history_id History ID (generated history)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [String] :sort_by Sort by (default to timestamp)
+    # @option opts [String] :sort_order Sort order (default to desc)
+    # @option opts [Array<String>] :action Flow actions
+    # @return [HistoryListing]
+    def get_flow_history_history_id(flow_id, history_id, opts = {})
+      data, _status_code, _headers = get_flow_history_history_id_with_http_info(flow_id, history_id, opts)
+      return data
+    end
+
+    # Get generated flow history
+    # 
+    # @param flow_id Flow ID
+    # @param history_id History ID (generated history)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_number Page number
+    # @option opts [Integer] :page_size Page size
+    # @option opts [String] :sort_by Sort by
+    # @option opts [String] :sort_order Sort order
+    # @option opts [Array<String>] :action Flow actions
+    # @return [Array<(HistoryListing, Fixnum, Hash)>] HistoryListing data, response status code and response headers
+    def get_flow_history_history_id_with_http_info(flow_id, history_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ArchitectApi.get_flow_history_history_id ..."
+      end
+      
+      
+      # verify the required parameter 'flow_id' is set
+      fail ArgumentError, "Missing the required parameter 'flow_id' when calling ArchitectApi.get_flow_history_history_id" if flow_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'history_id' is set
+      fail ArgumentError, "Missing the required parameter 'history_id' when calling ArchitectApi.get_flow_history_history_id" if history_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'sort_by'] && !['action', 'timestamp', 'user'].include?(opts[:'sort_by'])
+        fail ArgumentError, 'invalid value for "sort_by", must be one of action, timestamp, user'
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/flows/{flowId}/history/{historyId}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s).sub('{' + 'historyId' + '}', history_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      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[:'action'] = @api_client.build_collection_param(opts[:'action'], :multi) if opts[:'action']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'HistoryListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ArchitectApi#get_flow_history_history_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get the latest configuration for flow
     # 
     # @param flow_id Flow ID

data/lib/purecloudplatformclientv2/api/external_contacts_api.rb

@@ -1280,6 +1280,7 @@ module PureCloud
     # @option opts [Integer] :page_size Page size (default to 20)
     # @option opts [Integer] :page_number Page number (default to 1)
     # @option opts [String] :q Search query
+    # @option opts [Array<String>] :trustor_id Search for external organizations by trustorIds (limit 25). If supplied, the &#39;q&#39; parameters is ignored. Items are returned in the order requested
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
     # @option opts [BOOLEAN] :include_trustors (true or false) whether or not to include trustor information embedded in the externalOrganization
@@ -1295,6 +1296,7 @@ module PureCloud
     # @option opts [Integer] :page_size Page size
     # @option opts [Integer] :page_number Page number
     # @option opts [String] :q Search query
+    # @option opts [Array<String>] :trustor_id Search for external organizations by trustorIds (limit 25). If supplied, the &#39;q&#39; parameters is ignored. Items are returned in the order requested
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
     # @option opts [BOOLEAN] :include_trustors (true or false) whether or not to include trustor information embedded in the externalOrganization
@@ -1333,6 +1335,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1348,6 +1356,7 @@ module PureCloud
       query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
       query_params[:'q'] = opts[:'q'] if opts[:'q']
+      query_params[:'trustorId'] = @api_client.build_collection_param(opts[:'trustor_id'], :multi) if opts[:'trustor_id']
       query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
       query_params[:'includeTrustors'] = opts[:'include_trustors'] if opts[:'include_trustors']

data/lib/purecloudplatformclientv2/api/outbound_api.rb

@@ -4631,7 +4631,7 @@ module PureCloud
     # @param contact_list_id Contact List ID
     # @param body Contact
     # @param [Hash] opts the optional parameters
-    # @option opts [BOOLEAN] :priority Contact priority.  True means the contact(s) will go to the beginning of the list, false means at the end.
+    # @option opts [BOOLEAN] :priority Contact priority.  True means the contact(s) will be dialed next, false means the contact will go to the end of the contact queue.
     # @option opts [BOOLEAN] :clear_system_data Clear system data.  True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won't.
     # @return [Array<DialerContact>]
     def post_outbound_contactlist_contacts(contact_list_id, body, opts = {})
@@ -4644,7 +4644,7 @@ module PureCloud
     # @param contact_list_id Contact List ID
     # @param body Contact
     # @param [Hash] opts the optional parameters
-    # @option opts [BOOLEAN] :priority Contact priority.  True means the contact(s) will go to the beginning of the list, false means at the end.
+    # @option opts [BOOLEAN] :priority Contact priority.  True means the contact(s) will be dialed next, false means the contact will go to the end of the contact queue.
     # @option opts [BOOLEAN] :clear_system_data Clear system data.  True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won&#39;t.
     # @return [Array<(Array<DialerContact>, Fixnum, Hash)>] Array<DialerContact> data, response status code and response headers
     def post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts = {})

data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb

@@ -26,16 +26,16 @@ module PureCloud
 
     attr_accessor :total
 
-    attr_accessor :self_uri
-
-    attr_accessor :first_uri
-
     attr_accessor :previous_uri
 
     attr_accessor :next_uri
 
     attr_accessor :last_uri
 
+    attr_accessor :self_uri
+
+    attr_accessor :first_uri
+
     attr_accessor :page_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,16 +50,16 @@ module PureCloud
         
         :'total' => :'total',
         
-        :'self_uri' => :'selfUri',
-        
-        :'first_uri' => :'firstUri',
-        
         :'previous_uri' => :'previousUri',
         
         :'next_uri' => :'nextUri',
         
         :'last_uri' => :'lastUri',
         
+        :'self_uri' => :'selfUri',
+        
+        :'first_uri' => :'firstUri',
+        
         :'page_count' => :'pageCount'
         
       }
@@ -77,16 +77,16 @@ module PureCloud
         
         :'total' => :'Integer',
         
-        :'self_uri' => :'String',
-        
-        :'first_uri' => :'String',
-        
         :'previous_uri' => :'String',
         
         :'next_uri' => :'String',
         
         :'last_uri' => :'String',
         
+        :'self_uri' => :'String',
+        
+        :'first_uri' => :'String',
+        
         :'page_count' => :'Integer'
         
       }
@@ -139,46 +139,46 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'selfUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.self_uri = attributes[:'selfUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'firstUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.first_uri = attributes[:'firstUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'selfUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.self_uri = attributes[:'selfUri']
         
       
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'firstUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.first_uri = attributes[:'firstUri']
         
       
       end
@@ -310,11 +310,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 &&
           previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
           last_uri == o.last_uri &&
+          self_uri == o.self_uri &&
+          first_uri == o.first_uri &&
           page_count == o.page_count
     end
 
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, previous_uri, next_uri, last_uri, self_uri, first_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb

@@ -26,16 +26,16 @@ module PureCloud
 
     attr_accessor :total
 
-    attr_accessor :self_uri
-
-    attr_accessor :first_uri
-
     attr_accessor :previous_uri
 
     attr_accessor :next_uri
 
     attr_accessor :last_uri
 
+    attr_accessor :self_uri
+
+    attr_accessor :first_uri
+
     attr_accessor :page_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,16 +50,16 @@ module PureCloud
         
         :'total' => :'total',
         
-        :'self_uri' => :'selfUri',
-        
-        :'first_uri' => :'firstUri',
-        
         :'previous_uri' => :'previousUri',
         
         :'next_uri' => :'nextUri',
         
         :'last_uri' => :'lastUri',
         
+        :'self_uri' => :'selfUri',
+        
+        :'first_uri' => :'firstUri',
+        
         :'page_count' => :'pageCount'
         
       }
@@ -77,16 +77,16 @@ module PureCloud
         
         :'total' => :'Integer',
         
-        :'self_uri' => :'String',
-        
-        :'first_uri' => :'String',
-        
         :'previous_uri' => :'String',
         
         :'next_uri' => :'String',
         
         :'last_uri' => :'String',
         
+        :'self_uri' => :'String',
+        
+        :'first_uri' => :'String',
+        
         :'page_count' => :'Integer'
         
       }
@@ -139,46 +139,46 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'selfUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.self_uri = attributes[:'selfUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'firstUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.first_uri = attributes[:'firstUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'selfUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.self_uri = attributes[:'selfUri']
         
       
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'firstUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.first_uri = attributes[:'firstUri']
         
       
       end
@@ -310,11 +310,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 &&
           previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
           last_uri == o.last_uri &&
+          self_uri == o.self_uri &&
+          first_uri == o.first_uri &&
           page_count == o.page_count
     end
 
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, previous_uri, next_uri, last_uri, self_uri, first_uri, page_count].hash
     end
 
     # build the object from hash