purecloudplatformclientv2 28.0.1 → 29.0.0

data/lib/purecloudplatformclientv2/api/analytics_api.rb

@@ -153,6 +153,61 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get all view export requests for a user
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [ReportingExportJobListing]
+    def get_analytics_reporting_exports(opts = {})
+      data, _status_code, _headers = get_analytics_reporting_exports_with_http_info(opts)
+      return data
+    end
+
+    # Get all view export requests for a user
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ReportingExportJobListing, Fixnum, Hash)>] ReportingExportJobListing data, response status code and response headers
+    def get_analytics_reporting_exports_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_exports ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/analytics/reporting/exports".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # 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 => 'ReportingExportJobListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_reporting_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get list of reporting metadata.
     # 
     # @param [Hash] opts the optional parameters
@@ -1115,6 +1170,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Generate a view export request
+    # 
+    # @param body ReportingExportJobRequest
+    # @param [Hash] opts the optional parameters
+    # @return [ReportingExportJobResponse]
+    def post_analytics_reporting_exports(body, opts = {})
+      data, _status_code, _headers = post_analytics_reporting_exports_with_http_info(body, opts)
+      return data
+    end
+
+    # Generate a view export request
+    # 
+    # @param body ReportingExportJobRequest
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ReportingExportJobResponse, Fixnum, Hash)>] ReportingExportJobResponse data, response status code and response headers
+    def post_analytics_reporting_exports_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_reporting_exports ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_reporting_exports" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/analytics/reporting/exports".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # 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 = @api_client.object_to_http_body(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 => 'ReportingExportJobResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_reporting_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Place a scheduled report immediately into the reporting queue
     # 
     # @param schedule_id Schedule ID

data/lib/purecloudplatformclientv2/api/architect_api.rb

@@ -4001,8 +4001,8 @@ module PureCloud
     # Returns all of the rows for the datatable with the given id.  By default this will just be a shortened list returning the key for each row.  Set expand to all to return all of the row contents.
     # @param datatable_id id of datatable
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size (default to 25)
     # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Integer] :page_size Page size (default to 25)
     # @option opts [BOOLEAN] :showbrief If true returns just the key value of the row (default to true)
     # @return [DataTableRowEntityListing]
     def get_flows_datatable_rows(datatable_id, opts = {})
@@ -4014,8 +4014,8 @@ module PureCloud
     # Returns all of the rows for the datatable with the given id.  By default this will just be a shortened list returning the key for each row.  Set expand to all to return all of the row contents.
     # @param datatable_id id of datatable
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
     # @option opts [Integer] :page_number Page number
+    # @option opts [Integer] :page_size Page size
     # @option opts [BOOLEAN] :showbrief If true returns just the key value of the row
     # @return [Array<(DataTableRowEntityListing, Fixnum, Hash)>] DataTableRowEntityListing data, response status code and response headers
     def get_flows_datatable_rows_with_http_info(datatable_id, opts = {})
@@ -4054,8 +4054,8 @@ module PureCloud
 
       # query parameters
       query_params = {}
-      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'showbrief'] = opts[:'showbrief'] if opts[:'showbrief']
 
       # header parameters
@@ -4093,8 +4093,8 @@ module PureCloud
     # Returns a metadata list of the datatables associated with this org, including ID, name and description.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :expand Expand instructions for the result
-    # @option opts [Integer] :page_size Page size (default to 25)
     # @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 id)
     # @option opts [String] :sort_order Sort order (default to ascending)
     # @return [DataTablesDomainEntityListing]
@@ -4107,8 +4107,8 @@ module PureCloud
     # Returns a metadata list of the datatables associated with this org, including ID, name and description.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :expand Expand instructions for the result
-    # @option opts [Integer] :page_size Page size
     # @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
     # @return [Array<(DataTablesDomainEntityListing, Fixnum, Hash)>] DataTablesDomainEntityListing data, response status code and response headers
@@ -4165,8 +4165,8 @@ module PureCloud
       # query parameters
       query_params = {}
       query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
-      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       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']
 

data/lib/purecloudplatformclientv2/api/authorization_api.rb

@@ -769,6 +769,96 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
+    # 
+    # @param division_id Division ID
+    # @param object_type The type of the objects. Must be one of the valid object types
+    # @param body Object Id List
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AuthzTypedObject>]
+    def post_authorization_division_object(division_id, object_type, body, opts = {})
+      data, _status_code, _headers = post_authorization_division_object_with_http_info(division_id, object_type, body, opts)
+      return data
+    end
+
+    # Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
+    # 
+    # @param division_id Division ID
+    # @param object_type The type of the objects. Must be one of the valid object types
+    # @param body Object Id List
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AuthzTypedObject>, Fixnum, Hash)>] Array<AuthzTypedObject> data, response status code and response headers
+    def post_authorization_division_object_with_http_info(division_id, object_type, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_division_object ..."
+      end
+      
+      
+      # verify the required parameter 'division_id' is set
+      fail ArgumentError, "Missing the required parameter 'division_id' when calling AuthorizationApi.post_authorization_division_object" if division_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'object_type' is set
+      fail ArgumentError, "Missing the required parameter 'object_type' when calling AuthorizationApi.post_authorization_division_object" if object_type.nil?
+      
+      # verify enum value
+      unless ['QUEUE', 'CAMPAIGN', 'CONTACTLIST', 'DNCLIST', 'MANAGEMENTUNIT', 'FLOW', 'USER'].include?(object_type)
+        fail ArgumentError, "invalid value for 'object_type', must be one of QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, USER"
+      end
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_division_object" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/authorization/divisions/{divisionId}/objects/{objectType}".sub('{format}','json').sub('{' + 'divisionId' + '}', division_id.to_s).sub('{' + 'objectType' + '}', object_type.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # 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 = @api_client.object_to_http_body(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 => 'Array<AuthzTypedObject>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthorizationApi#post_authorization_division_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get an unsaved org role to default role comparison
     # Allows users to compare their existing roles in an unsaved state to its default role
     # @param left_role_id Left Role ID

data/lib/purecloudplatformclientv2/api/notifications_api.rb

@@ -348,7 +348,7 @@ module PureCloud
     end
 
     # Create a new channel
-    # There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.
+    # There is a limit of 5 channels. Creating a 6th channel will remove the channel with oldest last used date.
     # @param [Hash] opts the optional parameters
     # @return [Channel]
     def post_notifications_channels(opts = {})
@@ -357,7 +357,7 @@ module PureCloud
     end
 
     # Create a new channel
-    # There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.
+    # There is a limit of 5 channels. Creating a 6th channel will remove the channel with oldest last used date.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Channel, Fixnum, Hash)>] Channel data, response status code and response headers
     def post_notifications_channels_with_http_info(opts = {})

data/lib/purecloudplatformclientv2/api/objects_api.rb

@@ -78,5 +78,95 @@ module PureCloud
       end
       return data, status_code, headers
     end
+
+    # Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
+    # 
+    # @param division_id Division ID
+    # @param object_type The type of the objects. Must be one of the valid object types
+    # @param body Object Id List
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AuthzTypedObject>]
+    def post_authorization_division_object(division_id, object_type, body, opts = {})
+      data, _status_code, _headers = post_authorization_division_object_with_http_info(division_id, object_type, body, opts)
+      return data
+    end
+
+    # Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
+    # 
+    # @param division_id Division ID
+    # @param object_type The type of the objects. Must be one of the valid object types
+    # @param body Object Id List
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AuthzTypedObject>, Fixnum, Hash)>] Array<AuthzTypedObject> data, response status code and response headers
+    def post_authorization_division_object_with_http_info(division_id, object_type, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ObjectsApi.post_authorization_division_object ..."
+      end
+      
+      
+      # verify the required parameter 'division_id' is set
+      fail ArgumentError, "Missing the required parameter 'division_id' when calling ObjectsApi.post_authorization_division_object" if division_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'object_type' is set
+      fail ArgumentError, "Missing the required parameter 'object_type' when calling ObjectsApi.post_authorization_division_object" if object_type.nil?
+      
+      # verify enum value
+      unless ['QUEUE', 'CAMPAIGN', 'CONTACTLIST', 'DNCLIST', 'MANAGEMENTUNIT', 'FLOW', 'USER'].include?(object_type)
+        fail ArgumentError, "invalid value for 'object_type', must be one of QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, USER"
+      end
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling ObjectsApi.post_authorization_division_object" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/authorization/divisions/{divisionId}/objects/{objectType}".sub('{format}','json').sub('{' + 'divisionId' + '}', division_id.to_s).sub('{' + 'objectType' + '}', object_type.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # 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 = @api_client.object_to_http_body(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 => 'Array<AuthzTypedObject>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ObjectsApi#post_authorization_division_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/purecloudplatformclientv2/api/outbound_api.rb

@@ -2131,6 +2131,7 @@ module PureCloud
     # @option opts [Integer] :page_number Page number (default to 1)
     # @option opts [String] :filter_type Filter type (default to Prefix)
     # @option opts [String] :name Name
+    # @option opts [Array<String>] :id id
     # @option opts [String] :contact_list_id Contact List ID
     # @option opts [String] :dnc_list_id DNC list ID
     # @option opts [String] :distribution_queue_id Distribution queue ID
@@ -2151,6 +2152,7 @@ module PureCloud
     # @option opts [Integer] :page_number Page number
     # @option opts [String] :filter_type Filter type
     # @option opts [String] :name Name
+    # @option opts [Array<String>] :id id
     # @option opts [String] :contact_list_id Contact List ID
     # @option opts [String] :dnc_list_id DNC list ID
     # @option opts [String] :distribution_queue_id Distribution queue ID
@@ -2224,6 +2226,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2247,6 +2255,7 @@ module PureCloud
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
       query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
       query_params[:'name'] = opts[:'name'] if opts[:'name']
+      query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
       query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']
       query_params[:'dncListId'] = opts[:'dnc_list_id'] if opts[:'dnc_list_id']
       query_params[:'distributionQueueId'] = opts[:'distribution_queue_id'] if opts[:'distribution_queue_id']
@@ -2783,6 +2792,7 @@ module PureCloud
     # @option opts [Integer] :page_number Page number (default to 1)
     # @option opts [String] :filter_type Filter type (default to Prefix)
     # @option opts [String] :name Name
+    # @option opts [Array<String>] :id id
     # @option opts [String] :sort_by Sort by
     # @option opts [String] :sort_order Sort order (default to a)
     # @return [ContactListEntityListing]
@@ -2800,6 +2810,7 @@ module PureCloud
     # @option opts [Integer] :page_number Page number
     # @option opts [String] :filter_type Filter type
     # @option opts [String] :name Name
+    # @option opts [Array<String>] :id id
     # @option opts [String] :sort_by Sort by
     # @option opts [String] :sort_order Sort order
     # @return [Array<(ContactListEntityListing, Fixnum, Hash)>] ContactListEntityListing data, response status code and response headers
@@ -2852,6 +2863,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2875,6 +2892,7 @@ module PureCloud
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
       query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
       query_params[:'name'] = opts[:'name'] if opts[:'name']
+      query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
       query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']