architect_api.rb in purecloudplatformclientv2-16.0.0

- old
+ new

@@ -819,11 +819,11 @@
 
     # Get resources that are consumed by a given Dependency Tracking object
     # 
     # @param id Consuming object ID
     # @param version Consuming object version
-    # @param object_type Consuming object type
+    # @param object_type Consuming object type.  Only versioned types are allowed here.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :resource_type Types of consumed resources to show
     # @return [ConsumedResourcesEntityListing]
     def get_architect_dependencytracking_consumedresources(id, version, object_type, opts = {})
       data, _status_code, _headers = get_architect_dependencytracking_consumedresources_with_http_info(id, version, object_type, opts)
@@ -832,11 +832,11 @@
 
     # Get resources that are consumed by a given Dependency Tracking object
     # 
     # @param id Consuming object ID
     # @param version Consuming object version
-    # @param object_type Consuming object type
+    # @param object_type Consuming object type.  Only versioned types are allowed here.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :resource_type Types of consumed resources to show
     # @return [Array<(ConsumedResourcesEntityListing, Fixnum, Hash)>] ConsumedResourcesEntityListing data, response status code and response headers
     def get_architect_dependencytracking_consumedresources_with_http_info(id, version, object_type, opts = {})
       if @api_client.config.debugging
@@ -862,12 +862,12 @@
       
       # verify the required parameter 'object_type' is set
       fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if object_type.nil?
       
       # verify enum value
-      unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
-        fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
+      unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGE', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
+        fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGE, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
       end
       
       
       
       
@@ -920,25 +920,25 @@
     end
 
     # Get resources that consume a given Dependency Tracking object
     # 
     # @param id Consumed object ID
-    # @param object_type Consumed object type (only versioned object types are valid)
+    # @param object_type Consumed object type
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :resource_type Types of consuming resources to show
+    # @option opts [Array<String>] :resource_type Types of consuming resources to show.  Only versioned types are allowed here.
     # @return [ConsumingResourcesEntityListing]
     def get_architect_dependencytracking_consumingresources(id, object_type, opts = {})
       data, _status_code, _headers = get_architect_dependencytracking_consumingresources_with_http_info(id, object_type, opts)
       return data
     end
 
     # Get resources that consume a given Dependency Tracking object
     # 
     # @param id Consumed object ID
-    # @param object_type Consumed object type (only versioned object types are valid)
+    # @param object_type Consumed object type
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :resource_type Types of consuming resources to show
+    # @option opts [Array<String>] :resource_type Types of consuming resources to show.  Only versioned types are allowed here.
     # @return [Array<(ConsumingResourcesEntityListing, Fixnum, Hash)>] ConsumingResourcesEntityListing data, response status code and response headers
     def get_architect_dependencytracking_consumingresources_with_http_info(id, object_type, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_dependencytracking_consumingresources ..."
       end
@@ -954,12 +954,12 @@
       
       # verify the required parameter 'object_type' is set
       fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumingresources" if object_type.nil?
       
       # verify enum value
-      unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
-        fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
+      unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGE', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
+        fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGE, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
       end
       
       
       
       
@@ -1179,12 +1179,12 @@
       
       
       
       
       
-      if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
-        fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW'
+      if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGE', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
+        fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGE, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW'
       end
       
       
       
       
@@ -1573,10 +1573,11 @@
     # @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 name)
     # @option opts [String] :sort_order Sort order (default to ASC)
+    # @option opts [String] :name Name of the IVR to filter by.
     # @return [IVREntityListing]
     def get_architect_ivrs(opts = {})
       data, _status_code, _headers = get_architect_ivrs_with_http_info(opts)
       return data
     end
@@ -1586,10 +1587,11 @@
     # @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 [String] :name Name of the IVR to filter by.
     # @return [Array<(IVREntityListing, Fixnum, Hash)>] IVREntityListing data, response status code and response headers
     def get_architect_ivrs_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_ivrs ..."
       end
@@ -1616,19 +1618,26 @@
       
       
       
       
       
+      
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/architect/ivrs".sub('{format}','json')
 
       # 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[:'name'] = opts[:'name'] if opts[:'name']
 
       # header parameters
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
@@ -2117,10 +2126,11 @@
     # @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 name)
     # @option opts [String] :sort_order Sort order (default to ASC)
+    # @option opts [String] :name Name of the Schedule Group to filter by.
     # @return [ScheduleGroupEntityListing]
     def get_architect_schedulegroups(opts = {})
       data, _status_code, _headers = get_architect_schedulegroups_with_http_info(opts)
       return data
     end
@@ -2130,10 +2140,11 @@
     # @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 [String] :name Name of the Schedule Group to filter by.
     # @return [Array<(ScheduleGroupEntityListing, Fixnum, Hash)>] ScheduleGroupEntityListing data, response status code and response headers
     def get_architect_schedulegroups_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_schedulegroups ..."
       end
@@ -2160,19 +2171,26 @@
       
       
       
       
       
+      
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/architect/schedulegroups".sub('{format}','json')
 
       # 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[:'name'] = opts[:'name'] if opts[:'name']
 
       # header parameters
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
@@ -2208,10 +2226,11 @@
     # @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 name)
     # @option opts [String] :sort_order Sort order (default to ASC)
+    # @option opts [String] :name Name of the Schedule to filter by.
     # @return [ScheduleEntityListing]
     def get_architect_schedules(opts = {})
       data, _status_code, _headers = get_architect_schedules_with_http_info(opts)
       return data
     end
@@ -2221,10 +2240,11 @@
     # @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 [String] :name Name of the Schedule to filter by.
     # @return [Array<(ScheduleEntityListing, Fixnum, Hash)>] ScheduleEntityListing data, response status code and response headers
     def get_architect_schedules_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_schedules ..."
       end
@@ -2251,19 +2271,26 @@
       
       
       
       
       
+      
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/architect/schedules".sub('{format}','json')
 
       # 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[:'name'] = opts[:'name'] if opts[:'name']
 
       # header parameters
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
@@ -2732,13 +2759,13 @@
     # @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
+    # @option opts [String] :sort_by Sort by (default to timestamp)
+    # @option opts [Array<String>] :action Flow actions to include (omit to include all)
     # @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
@@ -2748,13 +2775,13 @@
     # @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
+    # @option opts [String] :sort_by Sort by
+    # @option opts [Array<String>] :action Flow actions to include (omit to include all)
     # @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
@@ -2788,19 +2815,19 @@
       
       
       
       
       
-      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
       
       
       
       
       
       
+      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
       
       
       
       
       
@@ -2814,12 +2841,12 @@
 
       # 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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
       query_params[:'action'] = @api_client.build_collection_param(opts[:'action'], :multi) if opts[:'action']
 
       # header parameters
       header_params = {}
 
@@ -3234,9 +3261,14 @@
       end
       
       
       # verify the required parameter 'type' is set
       fail ArgumentError, "Missing the required parameter 'type' when calling ArchitectApi.get_flows" if type.nil?
+      
+      # verify enum value
+      unless ['inboundcall', 'inboundemail', 'inboundshortmessage', 'outboundcall', 'inqueuecall', 'speech', 'securecall', 'surveyinvite', 'workflow'].include?(type)
+        fail ArgumentError, "invalid value for 'type', must be one of inboundcall, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow"
+      end
       
       
       
       
       