purecloudplatformclientv2 51.0.0 → 52.0.0

data/docs/UsersApi.md

@@ -1563,6 +1563,7 @@ Wraps GET /api/v2/users/{userId}/queues
 
 Requires ANY permissions: 
 
+* routing:queue:view
 * routing:queue:join
 
 
@@ -3292,7 +3293,7 @@ Wraps POST /api/v2/users/{userId}/password
 Requires ANY permissions: 
 
 * user_administration
-* directory:userPassword:edit
+* directory:user:setPassword
 
 
 ### Example

data/lib/purecloudplatformclientv2.rb

@@ -579,7 +579,6 @@ require 'purecloudplatformclientv2/models/empty'
 require 'purecloudplatformclientv2/models/encryption_key'
 require 'purecloudplatformclientv2/models/encryption_key_entity_listing'
 require 'purecloudplatformclientv2/models/endpoint'
-require 'purecloudplatformclientv2/models/endpoint_entity_listing'
 require 'purecloudplatformclientv2/models/entity'
 require 'purecloudplatformclientv2/models/entry'
 require 'purecloudplatformclientv2/models/error_body'

data/lib/purecloudplatformclientv2/api/architect_api.rb

@@ -3855,7 +3855,7 @@ module PureCloud
     end
 
     # Get a pageable list of flows, filtered by query parameters
-    # Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.
+    # If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :type Type
     # @option opts [Integer] :page_number Page number (default to 1)
@@ -3882,7 +3882,7 @@ module PureCloud
     end
 
     # Get a pageable list of flows, filtered by query parameters
-    # Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.
+    # If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :type Type
     # @option opts [Integer] :page_number Page number
@@ -4438,7 +4438,7 @@ module PureCloud
     end
 
     # Get a pageable list of basic flow information objects filterable by query parameters.
-    # This returns a simplified version of /flow consisting of name and type.
+    # This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :type Type
     # @option opts [Integer] :page_number Page number (default to 1)
@@ -4458,7 +4458,7 @@ module PureCloud
     end
 
     # Get a pageable list of basic flow information objects filterable by query parameters.
-    # This returns a simplified version of /flow consisting of name and type.
+    # This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :type Type
     # @option opts [Integer] :page_number Page number

data/lib/purecloudplatformclientv2/api/groups_api.rb

@@ -550,6 +550,7 @@ module PureCloud
     # @option opts [Integer] :page_size Page size (default to 25)
     # @option opts [Integer] :page_number Page number (default to 1)
     # @option opts [Array<String>] :id id
+    # @option opts [Array<String>] :jabber_id A list of jabberIds to fetch by bulk (cannot be used with the \&quot;id\&quot; parameter)
     # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
     # @return [GroupEntityListing]
     def get_groups(opts = {})
@@ -563,6 +564,7 @@ module PureCloud
     # @option opts [Integer] :page_size Page size
     # @option opts [Integer] :page_number Page number
     # @option opts [Array<String>] :id id
+    # @option opts [Array<String>] :jabber_id A list of jabberIds to fetch by bulk (cannot be used with the \&quot;id\&quot; parameter)
     # @option opts [String] :sort_order Ascending or descending sort order
     # @return [Array<(GroupEntityListing, Fixnum, Hash)>] GroupEntityListing data, response status code and response headers
     def get_groups_with_http_info(opts = {})
@@ -584,6 +586,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -606,6 +614,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[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
+      query_params[:'jabberId'] = @api_client.build_collection_param(opts[:'jabber_id'], :multi) if opts[:'jabber_id']
       query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
 
       # header parameters

data/lib/purecloudplatformclientv2/api/outbound_api.rb

@@ -2304,6 +2304,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get a basic Campaign information object
+    # This returns a simplified version of a Campaign, consisting of name and division.
+    # @param campaign_id Campaign ID
+    # @param [Hash] opts the optional parameters
+    # @return [CampaignDivisionView]
+    def get_outbound_campaigns_divisionview(campaign_id, opts = {})
+      data, _status_code, _headers = get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts)
+      return data
+    end
+
+    # Get a basic Campaign information object
+    # This returns a simplified version of a Campaign, consisting of name and division.
+    # @param campaign_id Campaign ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CampaignDivisionView, Fixnum, Hash)>] CampaignDivisionView data, response status code and response headers
+    def get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionview ..."
+      end
+      
+      
+      # verify the required parameter 'campaign_id' is set
+      fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaigns_divisionview" if campaign_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/outbound/campaigns/divisionviews/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.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 = nil
+      
+      auth_names = ['PureCloud OAuth']
+      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 => 'CampaignDivisionView')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Query a list of basic Campaign information objects
     # This returns a simplified version of a Campaign, consisting of name and division.
     # @param [Hash] opts the optional parameters

data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb

@@ -418,70 +418,6 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Delete endpoint
-    # 
-    # @param endpoint_id Endpoint ID
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def delete_telephony_providers_edges_endpoint(endpoint_id, opts = {})
-      delete_telephony_providers_edges_endpoint_with_http_info(endpoint_id, opts)
-      return nil
-    end
-
-    # Delete endpoint
-    # 
-    # @param endpoint_id Endpoint ID
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def delete_telephony_providers_edges_endpoint_with_http_info(endpoint_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_endpoint ..."
-      end
-      
-      
-      # verify the required parameter 'endpoint_id' is set
-      fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_endpoint" if endpoint_id.nil?
-      
-      
-      
-      
-      
-      # resource path
-      local_var_path = "/api/v2/telephony/providers/edges/endpoints/{endpointId}".sub('{format}','json').sub('{' + 'endpointId' + '}', endpoint_id.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 = nil
-      
-      auth_names = ['PureCloud OAuth']
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_telephony_providers_edges_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Delete an extension pool by ID
     # 
     # @param extension_pool_id Extension pool ID
@@ -3285,162 +3221,6 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get endpoint
-    # 
-    # @param endpoint_id Endpoint ID
-    # @param [Hash] opts the optional parameters
-    # @return [Endpoint]
-    def get_telephony_providers_edges_endpoint(endpoint_id, opts = {})
-      data, _status_code, _headers = get_telephony_providers_edges_endpoint_with_http_info(endpoint_id, opts)
-      return data
-    end
-
-    # Get endpoint
-    # 
-    # @param endpoint_id Endpoint ID
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Endpoint, Fixnum, Hash)>] Endpoint data, response status code and response headers
-    def get_telephony_providers_edges_endpoint_with_http_info(endpoint_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_endpoint ..."
-      end
-      
-      
-      # verify the required parameter 'endpoint_id' is set
-      fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_endpoint" if endpoint_id.nil?
-      
-      
-      
-      
-      
-      # resource path
-      local_var_path = "/api/v2/telephony/providers/edges/endpoints/{endpointId}".sub('{format}','json').sub('{' + 'endpointId' + '}', endpoint_id.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 = nil
-      
-      auth_names = ['PureCloud OAuth']
-      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 => 'Endpoint')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edges_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get endpoints
-    # 
-    # @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 [String] :name Name
-    # @option opts [String] :sort_by Sort by (default to name)
-    # @return [EndpointEntityListing]
-    def get_telephony_providers_edges_endpoints(opts = {})
-      data, _status_code, _headers = get_telephony_providers_edges_endpoints_with_http_info(opts)
-      return data
-    end
-
-    # Get endpoints
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
-    # @option opts [String] :name Name
-    # @option opts [String] :sort_by Sort by
-    # @return [Array<(EndpointEntityListing, Fixnum, Hash)>] EndpointEntityListing data, response status code and response headers
-    def get_telephony_providers_edges_endpoints_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_endpoints ..."
-      end
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      # resource path
-      local_var_path = "/api/v2/telephony/providers/edges/endpoints".sub('{format}','json')
-
-      # 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[:'name'] = opts[:'name'] if opts[:'name']
-      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
-
-      # 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 OAuth']
-      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 => 'EndpointEntityListing')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edges_endpoints\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Get an extension by ID.
     # 
     # @param extension_id Extension ID
@@ -7385,71 +7165,6 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Create endpoint
-    # 
-    # @param body EndpointTemplate
-    # @param [Hash] opts the optional parameters
-    # @return [Endpoint]
-    def post_telephony_providers_edges_endpoints(body, opts = {})
-      data, _status_code, _headers = post_telephony_providers_edges_endpoints_with_http_info(body, opts)
-      return data
-    end
-
-    # Create endpoint
-    # 
-    # @param body EndpointTemplate
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Endpoint, Fixnum, Hash)>] Endpoint data, response status code and response headers
-    def post_telephony_providers_edges_endpoints_with_http_info(body, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_endpoints ..."
-      end
-      
-      
-      # verify the required parameter 'body' is set
-      fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_endpoints" if body.nil?
-      
-      
-      
-      
-      
-      # resource path
-      local_var_path = "/api/v2/telephony/providers/edges/endpoints".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 OAuth']
-      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 => 'Endpoint')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edges_endpoints\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Create a new extension pool
     # 
     # @param body ExtensionPool
@@ -8737,81 +8452,6 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Update endpoint
-    # 
-    # @param endpoint_id Endpoint ID
-    # @param body EndpointTemplate
-    # @param [Hash] opts the optional parameters
-    # @return [Endpoint]
-    def put_telephony_providers_edges_endpoint(endpoint_id, body, opts = {})
-      data, _status_code, _headers = put_telephony_providers_edges_endpoint_with_http_info(endpoint_id, body, opts)
-      return data
-    end
-
-    # Update endpoint
-    # 
-    # @param endpoint_id Endpoint ID
-    # @param body EndpointTemplate
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Endpoint, Fixnum, Hash)>] Endpoint data, response status code and response headers
-    def put_telephony_providers_edges_endpoint_with_http_info(endpoint_id, body, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_endpoint ..."
-      end
-      
-      
-      # verify the required parameter 'endpoint_id' is set
-      fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_endpoint" if endpoint_id.nil?
-      
-      
-      
-      
-      
-      
-      # verify the required parameter 'body' is set
-      fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_endpoint" if body.nil?
-      
-      
-      
-      
-      
-      # resource path
-      local_var_path = "/api/v2/telephony/providers/edges/endpoints/{endpointId}".sub('{format}','json').sub('{' + 'endpointId' + '}', endpoint_id.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 OAuth']
-      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Endpoint')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_telephony_providers_edges_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Update an extension by ID.
     # 
     # @param extension_id Extension ID