purecloudplatformclientv2 89.0.0 → 94.0.0

data/lib/purecloudplatformclientv2/api/search_api.rb

@@ -479,6 +479,7 @@ module PureCloud
     # @param q64 q64
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand expand
+    # @option opts [String] :integration_presence_source integrationPresenceSource
     # @return [UsersSearchResponse]
     def get_users_search(q64, opts = {})
       data, _status_code, _headers = get_users_search_with_http_info(q64, opts)
@@ -490,6 +491,7 @@ module PureCloud
     # @param q64 q64
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand expand
+    # @option opts [String] :integration_presence_source integrationPresenceSource
     # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
     def get_users_search_with_http_info(q64, opts = {})
       if @api_client.config.debugging
@@ -510,6 +512,16 @@ module PureCloud
       
       
       
+      
+      
+      
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/users/search".sub('{format}','json')
 
@@ -517,6 +529,7 @@ module PureCloud
       query_params = {}
       query_params[:'q64'] = q64
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
 
       # header parameters
       header_params = {}

data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb

@@ -3001,6 +3001,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 [String] :sort_by Sort by (default to number)
+    # @option opts [Array<String>] :id Filter by a specific list of ID&#39;s
     # @return [DIDPoolEntityListing]
     def get_telephony_providers_edges_didpools(opts = {})
       data, _status_code, _headers = get_telephony_providers_edges_didpools_with_http_info(opts)
@@ -3013,6 +3014,7 @@ module PureCloud
     # @option opts [Integer] :page_size Page size
     # @option opts [Integer] :page_number Page number
     # @option opts [String] :sort_by Sort by
+    # @option opts [Array<String>] :id Filter by a specific list of ID&#39;s
     # @return [Array<(DIDPoolEntityListing, Fixnum, Hash)>] DIDPoolEntityListing data, response status code and response headers
     def get_telephony_providers_edges_didpools_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -3032,6 +3034,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -3045,6 +3053,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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
+      query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
 
       # header parameters
       header_params = {}
@@ -3087,6 +3096,7 @@ module PureCloud
     # @option opts [String] :phone_number Filter by phoneNumber
     # @option opts [String] :owner_id Filter by the owner of a phone number
     # @option opts [String] :did_pool_id Filter by the DID Pool assignment
+    # @option opts [Array<String>] :id Filter by a specific list of ID&#39;s
     # @return [DIDEntityListing]
     def get_telephony_providers_edges_dids(opts = {})
       data, _status_code, _headers = get_telephony_providers_edges_dids_with_http_info(opts)
@@ -3103,6 +3113,7 @@ module PureCloud
     # @option opts [String] :phone_number Filter by phoneNumber
     # @option opts [String] :owner_id Filter by the owner of a phone number
     # @option opts [String] :did_pool_id Filter by the DID Pool assignment
+    # @option opts [Array<String>] :id Filter by a specific list of ID&#39;s
     # @return [Array<(DIDEntityListing, Fixnum, Hash)>] DIDEntityListing data, response status code and response headers
     def get_telephony_providers_edges_dids_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -3144,6 +3155,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -3163,6 +3180,7 @@ module PureCloud
       query_params[:'phoneNumber'] = opts[:'phone_number'] if opts[:'phone_number']
       query_params[:'owner.id'] = opts[:'owner_id'] if opts[:'owner_id']
       query_params[:'didPool.id'] = opts[:'did_pool_id'] if opts[:'did_pool_id']
+      query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
 
       # header parameters
       header_params = {}

data/lib/purecloudplatformclientv2/api/textbots_api.rb

@@ -0,0 +1,92 @@
+=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 TextbotsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Send an intent to a bot to start a dialog/interact with it via text
+    # This will either start a bot with the given id or relay a communication to an existing bot session.
+    # @param post_text_request 
+    # @param [Hash] opts the optional parameters
+    # @return [PostTextResponse]
+    def post_textbots_bots_execute(post_text_request, opts = {})
+      data, _status_code, _headers = post_textbots_bots_execute_with_http_info(post_text_request, opts)
+      return data
+    end
+
+    # Send an intent to a bot to start a dialog/interact with it via text
+    # This will either start a bot with the given id or relay a communication to an existing bot session.
+    # @param post_text_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PostTextResponse, Fixnum, Hash)>] PostTextResponse data, response status code and response headers
+    def post_textbots_bots_execute_with_http_info(post_text_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TextbotsApi.post_textbots_bots_execute ..."
+      end
+      
+      
+      # verify the required parameter 'post_text_request' is set
+      fail ArgumentError, "Missing the required parameter 'post_text_request' when calling TextbotsApi.post_textbots_bots_execute" if post_text_request.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/textbots/bots/execute".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(post_text_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 => 'PostTextResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TextbotsApi#post_textbots_bots_execute\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)
@@ -1178,6 +1178,7 @@ module PureCloud
     # @option opts [Array<String>] :jid jid
     # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;.
     # @return [UserProfileEntityListing]
     def get_profiles_users(opts = {})
       data, _status_code, _headers = get_profiles_users_with_http_info(opts)
@@ -1185,7 +1186,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
@@ -1193,6 +1194,7 @@ module PureCloud
     # @option opts [Array<String>] :jid jid
     # @option opts [String] :sort_order Ascending or descending sort order
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;.
     # @return [Array<(UserProfileEntityListing, Fixnum, Hash)>] UserProfileEntityListing data, response status code and response headers
     def get_profiles_users_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1239,6 +1241,16 @@ module PureCloud
       
       
       
+      
+      
+      
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/profiles/users".sub('{format}','json')
 
@@ -1250,6 +1262,7 @@ module PureCloud
       query_params[:'jid'] = @api_client.build_collection_param(opts[:'jid'], :multi) if opts[:'jid']
       query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
 
       # header parameters
       header_params = {}
@@ -1352,6 +1365,7 @@ module PureCloud
     # @param user_id User ID
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
     # @option opts [String] :state Search for a user with this state (default to active)
     # @return [User]
     def get_user(user_id, opts = {})
@@ -1364,6 +1378,7 @@ module PureCloud
     # @param user_id User ID
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
     # @option opts [String] :state Search for a user with this state
     # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
     def get_user_with_http_info(user_id, opts = {})
@@ -1388,6 +1403,16 @@ module PureCloud
       
       
       
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
+      
+      
+      
       if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
         fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
       end
@@ -1401,6 +1426,7 @@ module PureCloud
       # query parameters
       query_params = {}
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
       query_params[:'state'] = opts[:'state'] if opts[:'state']
 
       # header parameters
@@ -1889,10 +1915,11 @@ 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
+    # @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
     # @return [UserProfile]
     def get_user_profile(user_id, opts = {})
       data, _status_code, _headers = get_user_profile_with_http_info(user_id, opts)
@@ -1900,10 +1927,11 @@ 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
+    # @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
     # @return [Array<(UserProfile, Fixnum, Hash)>] UserProfile data, response status code and response headers
     def get_user_profile_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
@@ -1924,12 +1952,23 @@ module PureCloud
       
       
       
+      
+      
+      
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/users/{userId}/profile".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
 
       # query parameters
       query_params = {}
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
 
       # header parameters
       header_params = {}
@@ -2681,6 +2720,7 @@ module PureCloud
     # @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)
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;. When using this parameter the maximum number of users that can be returned is 10.
     # @option opts [String] :state Only list users of this state (default to active)
     # @return [UserEntityListing]
     def get_users(opts = {})
@@ -2697,6 +2737,7 @@ module PureCloud
     # @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
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;. When using this parameter the maximum number of users that can be returned is 10.
     # @option opts [String] :state Only list users of this state
     # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
     def get_users_with_http_info(opts = {})
@@ -2747,6 +2788,16 @@ module PureCloud
       
       
       
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
+      
+      
+      
       if opts[:'state'] && !['active', 'inactive', 'deleted', 'any'].include?(opts[:'state'])
         fail ArgumentError, 'invalid value for "state", must be one of active, inactive, deleted, any'
       end
@@ -2765,6 +2816,7 @@ module PureCloud
       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']
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
       query_params[:'state'] = opts[:'state'] if opts[:'state']
 
       # header parameters
@@ -2802,6 +2854,7 @@ module PureCloud
     # This request is not valid when using the Client Credentials OAuth grant.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand.
+    # @option opts [String] :integration_presence_source Get your presence for a given integration. This parameter will only be used when presence is provided as an \&quot;expand\&quot;.
     # @return [UserMe]
     def get_users_me(opts = {})
       data, _status_code, _headers = get_users_me_with_http_info(opts)
@@ -2812,6 +2865,7 @@ module PureCloud
     # This request is not valid when using the Client Credentials OAuth grant.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand Which fields, if any, to expand.
+    # @option opts [String] :integration_presence_source Get your presence for a given integration. This parameter will only be used when presence is provided as an \&quot;expand\&quot;.
     # @return [Array<(UserMe, Fixnum, Hash)>] UserMe data, response status code and response headers
     def get_users_me_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -2824,12 +2878,23 @@ module PureCloud
       
       
       
+      
+      
+      
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/users/me".sub('{format}','json')
 
       # query parameters
       query_params = {}
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
 
       # header parameters
       header_params = {}
@@ -2867,6 +2932,7 @@ module PureCloud
     # @param q64 q64
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand expand
+    # @option opts [String] :integration_presence_source integrationPresenceSource
     # @return [UsersSearchResponse]
     def get_users_search(q64, opts = {})
       data, _status_code, _headers = get_users_search_with_http_info(q64, opts)
@@ -2878,6 +2944,7 @@ module PureCloud
     # @param q64 q64
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :expand expand
+    # @option opts [String] :integration_presence_source integrationPresenceSource
     # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
     def get_users_search_with_http_info(q64, opts = {})
       if @api_client.config.debugging
@@ -2898,6 +2965,16 @@ module PureCloud
       
       
       
+      
+      
+      
+      if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
+        fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
+      end
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/users/search".sub('{format}','json')
 
@@ -2905,6 +2982,7 @@ module PureCloud
       query_params = {}
       query_params[:'q64'] = q64
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
 
       # header parameters
       header_params = {}