purecloudplatformclientv2 86.0.0 → 91.0.0

data/lib/purecloudplatformclientv2/api/groups_api.rb

@@ -471,7 +471,7 @@ module PureCloud
     end
 
     # Get group profile
-    # 
+    # This api is deprecated. Use /api/v2/groups instead
     # @param group_id groupId
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields Comma separated fields to return.  Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
@@ -482,7 +482,7 @@ module PureCloud
     end
 
     # Get group profile
-    # 
+    # This api is deprecated. Use /api/v2/groups instead
     # @param group_id groupId
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields Comma separated fields to return.  Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
@@ -724,7 +724,7 @@ module PureCloud
     end
 
     # Get group profile listing
-    # 
+    # This api is deprecated. Use /api/v2/groups instead.
     # @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)
@@ -737,7 +737,7 @@ module PureCloud
     end
 
     # Get group profile listing
-    # 
+    # This api is deprecated. Use /api/v2/groups instead.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size Page size
     # @option opts [Integer] :page_number Page number

data/lib/purecloudplatformclientv2/api/identity_provider_api.rb

@@ -134,6 +134,61 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Delete Generic SAML Identity Provider
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Empty]
+    def delete_identityproviders_generic(opts = {})
+      data, _status_code, _headers = delete_identityproviders_generic_with_http_info(opts)
+      return data
+    end
+
+    # Delete Generic SAML Identity Provider
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
+    def delete_identityproviders_generic_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_generic ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/identityproviders/generic".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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Empty')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_generic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete G Suite Identity Provider
     # 
     # @param [Hash] opts the optional parameters
@@ -739,6 +794,61 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get Generic SAML Identity Provider
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [GenericSAML]
+    def get_identityproviders_generic(opts = {})
+      data, _status_code, _headers = get_identityproviders_generic_with_http_info(opts)
+      return data
+    end
+
+    # Get Generic SAML Identity Provider
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GenericSAML, Fixnum, Hash)>] GenericSAML data, response status code and response headers
+    def get_identityproviders_generic_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_generic ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/identityproviders/generic".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 => 'GenericSAML')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_generic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get G Suite Identity Provider
     # 
     # @param [Hash] opts the optional parameters
@@ -1309,6 +1419,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Update/Create Generic SAML Identity Provider
+    # 
+    # @param body Provider
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthProvider]
+    def put_identityproviders_generic(body, opts = {})
+      data, _status_code, _headers = put_identityproviders_generic_with_http_info(body, opts)
+      return data
+    end
+
+    # Update/Create Generic SAML Identity Provider
+    # 
+    # @param body Provider
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthProvider, Fixnum, Hash)>] OAuthProvider data, response status code and response headers
+    def put_identityproviders_generic_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_generic ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_generic" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/identityproviders/generic".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 => 'OAuthProvider')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_generic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update/Create G Suite Identity Provider
     # 
     # @param body Provider

data/lib/purecloudplatformclientv2/api/o_auth_api.rb

@@ -273,6 +273,155 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get the results of a usage query
+    # 
+    # @param execution_id ID of the query execution
+    # @param client_id Client ID
+    # @param [Hash] opts the optional parameters
+    # @return [ApiUsageQueryResult]
+    def get_oauth_client_usage_query_result(execution_id, client_id, opts = {})
+      data, _status_code, _headers = get_oauth_client_usage_query_result_with_http_info(execution_id, client_id, opts)
+      return data
+    end
+
+    # Get the results of a usage query
+    # 
+    # @param execution_id ID of the query execution
+    # @param client_id Client ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiUsageQueryResult, Fixnum, Hash)>] ApiUsageQueryResult data, response status code and response headers
+    def get_oauth_client_usage_query_result_with_http_info(execution_id, client_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_client_usage_query_result ..."
+      end
+      
+      
+      # verify the required parameter 'execution_id' is set
+      fail ArgumentError, "Missing the required parameter 'execution_id' when calling OAuthApi.get_oauth_client_usage_query_result" if execution_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'client_id' is set
+      fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.get_oauth_client_usage_query_result" if client_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}".sub('{format}','json').sub('{' + 'executionId' + '}', execution_id.to_s).sub('{' + 'clientId' + '}', client_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: OAuthApi#get_oauth_client_usage_query_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a summary of OAuth client API usage
+    # After calling this method, you will then need to poll for the query results based on the returned execution Id
+    # @param client_id Client ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :days Previous number of days to query (default to 7)
+    # @return [UsageExecutionResult]
+    def get_oauth_client_usage_summary(client_id, opts = {})
+      data, _status_code, _headers = get_oauth_client_usage_summary_with_http_info(client_id, opts)
+      return data
+    end
+
+    # Get a summary of OAuth client API usage
+    # After calling this method, you will then need to poll for the query results based on the returned execution Id
+    # @param client_id Client ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :days Previous number of days to query
+    # @return [Array<(UsageExecutionResult, Fixnum, Hash)>] UsageExecutionResult data, response status code and response headers
+    def get_oauth_client_usage_summary_with_http_info(client_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_client_usage_summary ..."
+      end
+      
+      
+      # verify the required parameter 'client_id' is set
+      fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.get_oauth_client_usage_summary" if client_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/oauth/clients/{clientId}/usage/summary".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'days'] = opts[:'days'] if opts[:'days']
+
+      # 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 => 'UsageExecutionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OAuthApi#get_oauth_client_usage_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # The list of OAuth clients
     # 
     # @param [Hash] opts the optional parameters
@@ -531,6 +680,81 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Query for OAuth client API usage
+    # After calling this method, you will then need to poll for the query results based on the returned execution Id
+    # @param client_id Client ID
+    # @param body Query
+    # @param [Hash] opts the optional parameters
+    # @return [UsageExecutionResult]
+    def post_oauth_client_usage_query(client_id, body, opts = {})
+      data, _status_code, _headers = post_oauth_client_usage_query_with_http_info(client_id, body, opts)
+      return data
+    end
+
+    # Query for OAuth client API usage
+    # After calling this method, you will then need to poll for the query results based on the returned execution Id
+    # @param client_id Client 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_oauth_client_usage_query_with_http_info(client_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OAuthApi.post_oauth_client_usage_query ..."
+      end
+      
+      
+      # verify the required parameter 'client_id' is set
+      fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.post_oauth_client_usage_query" if client_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling OAuthApi.post_oauth_client_usage_query" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/oauth/clients/{clientId}/usage/query".sub('{format}','json').sub('{' + 'clientId' + '}', client_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(: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: OAuthApi#post_oauth_client_usage_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create OAuth client
     # The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud.  The preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server.  If the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps.  If a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles  via the 'roleIds' field.
     # @param body Client