purecloudplatformclientv2 86.0.0 → 91.0.0

data/lib/purecloudplatformclientv2/api/organization_api.rb

@@ -150,6 +150,61 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get organization IP address whitelist settings
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [IpAddressAuthentication]
+    def get_organizations_ipaddressauthentication(opts = {})
+      data, _status_code, _headers = get_organizations_ipaddressauthentication_with_http_info(opts)
+      return data
+    end
+
+    # Get organization IP address whitelist settings
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IpAddressAuthentication, Fixnum, Hash)>] IpAddressAuthentication data, response status code and response headers
+    def get_organizations_ipaddressauthentication_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OrganizationApi.get_organizations_ipaddressauthentication ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/organizations/ipaddressauthentication".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 => 'IpAddressAuthentication')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationApi#get_organizations_ipaddressauthentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get organization.
     # 
     # @param [Hash] opts the optional parameters
@@ -405,6 +460,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Update organization IP address whitelist settings
+    # 
+    # @param body IP address Whitelist settings
+    # @param [Hash] opts the optional parameters
+    # @return [IpAddressAuthentication]
+    def put_organizations_ipaddressauthentication(body, opts = {})
+      data, _status_code, _headers = put_organizations_ipaddressauthentication_with_http_info(body, opts)
+      return data
+    end
+
+    # Update organization IP address whitelist settings
+    # 
+    # @param body IP address Whitelist settings
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IpAddressAuthentication, Fixnum, Hash)>] IpAddressAuthentication data, response status code and response headers
+    def put_organizations_ipaddressauthentication_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OrganizationApi.put_organizations_ipaddressauthentication ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationApi.put_organizations_ipaddressauthentication" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/organizations/ipaddressauthentication".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(: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 => 'IpAddressAuthentication')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationApi#put_organizations_ipaddressauthentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update organization.
     # 
     # @param [Hash] opts the optional parameters

data/lib/purecloudplatformclientv2/api/recording_api.rb

@@ -372,6 +372,9 @@ module PureCloud
     # @param recording_id Recording ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :format_id The desired media format. (default to WEBM)
+    # @option opts [String] :email_format_id The desired media format when downloading an email recording. (default to EML)
+    # @option opts [String] :chat_format_id The desired media format when downloading a chat recording. (default to ZIP)
+    # @option opts [String] :message_format_id The desired media format when downloading a message recording. (default to ZIP)
     # @option opts [BOOLEAN] :download requesting a download format of the recording (default to false)
     # @option opts [String] :file_name the name of the downloaded fileName
     # @option opts [String] :locale The locale for the requested file when downloading, as an ISO 639-1 code
@@ -387,6 +390,9 @@ module PureCloud
     # @param recording_id Recording ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :format_id The desired media format.
+    # @option opts [String] :email_format_id The desired media format when downloading an email recording.
+    # @option opts [String] :chat_format_id The desired media format when downloading a chat recording.
+    # @option opts [String] :message_format_id The desired media format when downloading a message recording.
     # @option opts [BOOLEAN] :download requesting a download format of the recording
     # @option opts [String] :file_name the name of the downloaded fileName
     # @option opts [String] :locale The locale for the requested file when downloading, as an ISO 639-1 code
@@ -425,6 +431,36 @@ module PureCloud
       
       
       
+      if opts[:'email_format_id'] && !['EML', 'NONE'].include?(opts[:'email_format_id'])
+        fail ArgumentError, 'invalid value for "email_format_id", must be one of EML, NONE'
+      end
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'chat_format_id'] && !['ZIP', 'NONE'].include?(opts[:'chat_format_id'])
+        fail ArgumentError, 'invalid value for "chat_format_id", must be one of ZIP, NONE'
+      end
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'message_format_id'] && !['ZIP', 'NONE'].include?(opts[:'message_format_id'])
+        fail ArgumentError, 'invalid value for "message_format_id", must be one of ZIP, NONE'
+      end
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -446,6 +482,9 @@ module PureCloud
       # query parameters
       query_params = {}
       query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
+      query_params[:'emailFormatId'] = opts[:'email_format_id'] if opts[:'email_format_id']
+      query_params[:'chatFormatId'] = opts[:'chat_format_id'] if opts[:'chat_format_id']
+      query_params[:'messageFormatId'] = opts[:'message_format_id'] if opts[:'message_format_id']
       query_params[:'download'] = opts[:'download'] if opts[:'download']
       query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']
       query_params[:'locale'] = opts[:'locale'] if opts[:'locale']
@@ -938,6 +977,9 @@ module PureCloud
     # @param orphan_id Orphan ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :format_id The desired media format. (default to WEBM)
+    # @option opts [String] :email_format_id The desired media format when downloading an email recording. (default to EML)
+    # @option opts [String] :chat_format_id The desired media format when downloading a chat recording. (default to ZIP)
+    # @option opts [String] :message_format_id The desired media format when downloading a message recording. (default to ZIP)
     # @option opts [BOOLEAN] :download requesting a download format of the recording (default to false)
     # @option opts [String] :file_name the name of the downloaded fileName
     # @option opts [String] :locale The locale for the requested file when downloading, as an ISO 639-1 code
@@ -952,6 +994,9 @@ module PureCloud
     # @param orphan_id Orphan ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :format_id The desired media format.
+    # @option opts [String] :email_format_id The desired media format when downloading an email recording.
+    # @option opts [String] :chat_format_id The desired media format when downloading a chat recording.
+    # @option opts [String] :message_format_id The desired media format when downloading a message recording.
     # @option opts [BOOLEAN] :download requesting a download format of the recording
     # @option opts [String] :file_name the name of the downloaded fileName
     # @option opts [String] :locale The locale for the requested file when downloading, as an ISO 639-1 code
@@ -982,6 +1027,36 @@ module PureCloud
       
       
       
+      if opts[:'email_format_id'] && !['EML', 'NONE'].include?(opts[:'email_format_id'])
+        fail ArgumentError, 'invalid value for "email_format_id", must be one of EML, NONE'
+      end
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'chat_format_id'] && !['ZIP', 'NONE'].include?(opts[:'chat_format_id'])
+        fail ArgumentError, 'invalid value for "chat_format_id", must be one of ZIP, NONE'
+      end
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'message_format_id'] && !['ZIP', 'NONE'].include?(opts[:'message_format_id'])
+        fail ArgumentError, 'invalid value for "message_format_id", must be one of ZIP, NONE'
+      end
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1003,6 +1078,9 @@ module PureCloud
       # query parameters
       query_params = {}
       query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
+      query_params[:'emailFormatId'] = opts[:'email_format_id'] if opts[:'email_format_id']
+      query_params[:'chatFormatId'] = opts[:'chat_format_id'] if opts[:'chat_format_id']
+      query_params[:'messageFormatId'] = opts[:'message_format_id'] if opts[:'message_format_id']
       query_params[:'download'] = opts[:'download'] if opts[:'download']
       query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']
       query_params[:'locale'] = opts[:'locale'] if opts[:'locale']

data/lib/purecloudplatformclientv2/api/usage_api.rb

@@ -0,0 +1,157 @@
+=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 UsageApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get the results of a usage query
+    # 
+    # @param execution_id ID of the query execution
+    # @param [Hash] opts the optional parameters
+    # @return [ApiUsageQueryResult]
+    def get_usage_query_execution_id_results(execution_id, opts = {})
+      data, _status_code, _headers = get_usage_query_execution_id_results_with_http_info(execution_id, opts)
+      return data
+    end
+
+    # Get the results of a usage query
+    # 
+    # @param execution_id ID of the query execution
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiUsageQueryResult, Fixnum, Hash)>] ApiUsageQueryResult data, response status code and response headers
+    def get_usage_query_execution_id_results_with_http_info(execution_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsageApi.get_usage_query_execution_id_results ..."
+      end
+      
+      
+      # verify the required parameter 'execution_id' is set
+      fail ArgumentError, "Missing the required parameter 'execution_id' when calling UsageApi.get_usage_query_execution_id_results" if execution_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/usage/query/{executionId}/results".sub('{format}','json').sub('{' + 'executionId' + '}', execution_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 => 'ApiUsageQueryResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsageApi#get_usage_query_execution_id_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Query organization API Usage - 
+    # After calling this method, you will then need to poll for the query results based on the returned execution Id
+    # @param body Query
+    # @param [Hash] opts the optional parameters
+    # @return [UsageExecutionResult]
+    def post_usage_query(body, opts = {})
+      data, _status_code, _headers = post_usage_query_with_http_info(body, opts)
+      return data
+    end
+
+    # Query organization API Usage - 
+    # After calling this method, you will then need to poll for the query results based on the returned execution Id
+    # @param body Query
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UsageExecutionResult, Fixnum, Hash)>] UsageExecutionResult data, response status code and response headers
+    def post_usage_query_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsageApi.post_usage_query ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling UsageApi.post_usage_query" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/usage/query".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 => 'UsageExecutionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsageApi#post_usage_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -1170,7 +1170,7 @@ module PureCloud
     end
 
     # Get a user profile listing
-    # 
+    # This api is deprecated. User /api/v2/users
     # @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)
@@ -1185,7 +1185,7 @@ module PureCloud
     end
 
     # Get a user profile listing
-    # 
+    # This api is deprecated. User /api/v2/users
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size Page size
     # @option opts [Integer] :page_number Page number
@@ -1889,7 +1889,7 @@ module PureCloud
     end
 
     # Get user profile
-    # 
+    # This api has been deprecated. Use api/v2/users instead
     # @param user_id userId
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
@@ -1900,7 +1900,7 @@ module PureCloud
     end
 
     # Get user profile
-    # 
+    # This api has been deprecated. Use api/v2/users instead
     # @param user_id userId
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand