purecloudplatformclientv2 62.0.0 → 66.0.0

data/lib/purecloudplatformclientv2/api/search_api.rb

@@ -235,7 +235,7 @@ module PureCloud
     # 
     # @param q64 q64
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :expand expand
+    # @option opts [Array<String>] :expand Provides more details about a specified resource
     # @return [LocationsSearchResponse]
     def get_locations_search(q64, opts = {})
       data, _status_code, _headers = get_locations_search_with_http_info(q64, opts)
@@ -246,7 +246,7 @@ module PureCloud
     # 
     # @param q64 q64
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :expand expand
+    # @option opts [Array<String>] :expand Provides more details about a specified resource
     # @return [Array<(LocationsSearchResponse, Fixnum, Hash)>] LocationsSearchResponse data, response status code and response headers
     def get_locations_search_with_http_info(q64, opts = {})
       if @api_client.config.debugging

data/lib/purecloudplatformclientv2/api/telephony_api.rb

@@ -0,0 +1,270 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
+
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
+
+=end
+
+require "uri"
+
+module PureCloud
+  class TelephonyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Fetch SIP metadata
+    # Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
+    # @param date_start Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # @param date_end End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :call_id unique identification of the placed call
+    # @option opts [String] :to_user User to who the call was placed
+    # @option opts [String] :from_user user who placed the call
+    # @option opts [String] :conversation_id Unique identification of the conversation
+    # @return [SipSearchResult]
+    def get_telephony_siptraces(date_start, date_end, opts = {})
+      data, _status_code, _headers = get_telephony_siptraces_with_http_info(date_start, date_end, opts)
+      return data
+    end
+
+    # Fetch SIP metadata
+    # Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
+    # @param date_start Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # @param date_end End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :call_id unique identification of the placed call
+    # @option opts [String] :to_user User to who the call was placed
+    # @option opts [String] :from_user user who placed the call
+    # @option opts [String] :conversation_id Unique identification of the conversation
+    # @return [Array<(SipSearchResult, Fixnum, Hash)>] SipSearchResult data, response status code and response headers
+    def get_telephony_siptraces_with_http_info(date_start, date_end, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TelephonyApi.get_telephony_siptraces ..."
+      end
+      
+      
+      # verify the required parameter 'date_start' is set
+      fail ArgumentError, "Missing the required parameter 'date_start' when calling TelephonyApi.get_telephony_siptraces" if date_start.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'date_end' is set
+      fail ArgumentError, "Missing the required parameter 'date_end' when calling TelephonyApi.get_telephony_siptraces" if date_end.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/telephony/siptraces".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'dateStart'] = date_start
+      query_params[:'dateEnd'] = date_end
+      query_params[:'callId'] = opts[:'call_id'] if opts[:'call_id']
+      query_params[:'toUser'] = opts[:'to_user'] if opts[:'to_user']
+      query_params[:'fromUser'] = opts[:'from_user'] if opts[:'from_user']
+      query_params[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id']
+
+      # 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 => 'SipSearchResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TelephonyApi#get_telephony_siptraces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get signed S3 URL for a pcap download
+    # 
+    # @param download_id unique id for the downloaded file in S3
+    # @param [Hash] opts the optional parameters
+    # @return [SignedUrlResponse]
+    def get_telephony_siptraces_download_download_id(download_id, opts = {})
+      data, _status_code, _headers = get_telephony_siptraces_download_download_id_with_http_info(download_id, opts)
+      return data
+    end
+
+    # Get signed S3 URL for a pcap download
+    # 
+    # @param download_id unique id for the downloaded file in S3
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SignedUrlResponse, Fixnum, Hash)>] SignedUrlResponse data, response status code and response headers
+    def get_telephony_siptraces_download_download_id_with_http_info(download_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TelephonyApi.get_telephony_siptraces_download_download_id ..."
+      end
+      
+      
+      # verify the required parameter 'download_id' is set
+      fail ArgumentError, "Missing the required parameter 'download_id' when calling TelephonyApi.get_telephony_siptraces_download_download_id" if download_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/telephony/siptraces/download/{downloadId}".sub('{format}','json').sub('{' + 'downloadId' + '}', download_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 => 'SignedUrlResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TelephonyApi#get_telephony_siptraces_download_download_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Request a download of a pcap file to S3
+    # 
+    # @param sip_search_public_request 
+    # @param [Hash] opts the optional parameters
+    # @return [SipDownloadResponse]
+    def post_telephony_siptraces_download(sip_search_public_request, opts = {})
+      data, _status_code, _headers = post_telephony_siptraces_download_with_http_info(sip_search_public_request, opts)
+      return data
+    end
+
+    # Request a download of a pcap file to S3
+    # 
+    # @param sip_search_public_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SipDownloadResponse, Fixnum, Hash)>] SipDownloadResponse data, response status code and response headers
+    def post_telephony_siptraces_download_with_http_info(sip_search_public_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TelephonyApi.post_telephony_siptraces_download ..."
+      end
+      
+      
+      # verify the required parameter 'sip_search_public_request' is set
+      fail ArgumentError, "Missing the required parameter 'sip_search_public_request' when calling TelephonyApi.post_telephony_siptraces_download" if sip_search_public_request.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/telephony/siptraces/download".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(sip_search_public_request)
+      
+      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 => 'SipDownloadResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TelephonyApi#post_telephony_siptraces_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb

@@ -5102,7 +5102,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get the list of Number Plans for this Site.
+    # Get the list of Number Plans for this Site. Only fetches the first 200 records.
     # 
     # @param site_id Site ID
     # @param [Hash] opts the optional parameters
@@ -5112,7 +5112,7 @@ module PureCloud
       return data
     end
 
-    # Get the list of Number Plans for this Site.
+    # Get the list of Number Plans for this Site. Only fetches the first 200 records.
     # 
     # @param site_id Site ID
     # @param [Hash] opts the optional parameters
@@ -8947,7 +8947,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Update the list of Number Plans.
+    # Update the list of Number Plans. A user can update maximum 200 number plans at a time.
     # 
     # @param site_id Site ID
     # @param body List of number plans
@@ -8958,7 +8958,7 @@ module PureCloud
       return data
     end
 
-    # Update the list of Number Plans.
+    # Update the list of Number Plans. A user can update maximum 200 number plans at a time.
     # 
     # @param site_id Site ID
     # @param body List of number plans

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -3583,7 +3583,7 @@ module PureCloud
     # 
     # @param body query
     # @param [Hash] opts the optional parameters
-    # @return [PresenceQueryResponse]
+    # @return [UserAggregateQueryResponse]
     def post_analytics_users_aggregates_query(body, opts = {})
       data, _status_code, _headers = post_analytics_users_aggregates_query_with_http_info(body, opts)
       return data
@@ -3593,7 +3593,7 @@ module PureCloud
     # 
     # @param body query
     # @param [Hash] opts the optional parameters
-    # @return [Array<(PresenceQueryResponse, Fixnum, Hash)>] PresenceQueryResponse data, response status code and response headers
+    # @return [Array<(UserAggregateQueryResponse, Fixnum, Hash)>] UserAggregateQueryResponse data, response status code and response headers
     def post_analytics_users_aggregates_query_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: UsersApi.post_analytics_users_aggregates_query ..."
@@ -3637,7 +3637,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'PresenceQueryResponse')
+        :return_type => 'UserAggregateQueryResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -3713,7 +3713,7 @@ module PureCloud
     # 
     # @param body query
     # @param [Hash] opts the optional parameters
-    # @return [ObservationQueryResponse]
+    # @return [UserObservationQueryResponse]
     def post_analytics_users_observations_query(body, opts = {})
       data, _status_code, _headers = post_analytics_users_observations_query_with_http_info(body, opts)
       return data
@@ -3723,7 +3723,7 @@ module PureCloud
     # 
     # @param body query
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers
+    # @return [Array<(UserObservationQueryResponse, Fixnum, Hash)>] UserObservationQueryResponse data, response status code and response headers
     def post_analytics_users_observations_query_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: UsersApi.post_analytics_users_observations_query ..."
@@ -3767,7 +3767,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'ObservationQueryResponse')
+        :return_type => 'UserObservationQueryResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -3780,7 +3780,7 @@ module PureCloud
     # @param division_id the id of the division to which to make the grant
     # @param role_id the id of the role to grant
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :subject_type what the type of the subject is, PC_GROUP or PC_USER (default to PC_USER)
+    # @option opts [String] :subject_type what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) (default to PC_USER)
     # @return [nil]
     def post_authorization_subject_division_role(subject_id, division_id, role_id, opts = {})
       post_authorization_subject_division_role_with_http_info(subject_id, division_id, role_id, opts)
@@ -3793,7 +3793,7 @@ module PureCloud
     # @param division_id the id of the division to which to make the grant
     # @param role_id the id of the role to grant
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :subject_type what the type of the subject is, PC_GROUP or PC_USER
+    # @option opts [String] :subject_type what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def post_authorization_subject_division_role_with_http_info(subject_id, division_id, role_id, opts = {})
       if @api_client.config.debugging

data/lib/purecloudplatformclientv2/api/utilities_api.rb

@@ -79,6 +79,61 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get public ip address ranges for PureCloud
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [IpAddressRangeListing]
+    def get_ipranges(opts = {})
+      data, _status_code, _headers = get_ipranges_with_http_info(opts)
+      return data
+    end
+
+    # Get public ip address ranges for PureCloud
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IpAddressRangeListing, Fixnum, Hash)>] IpAddressRangeListing data, response status code and response headers
+    def get_ipranges_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UtilitiesApi.get_ipranges ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/ipranges".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 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 => 'IpAddressRangeListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UtilitiesApi#get_ipranges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get time zones list
     # 
     # @param [Hash] opts the optional parameters