ultracart_api 4.1.67 → 4.1.69

data/lib/ultracart_api/api/conversation_api.rb

@@ -1138,6 +1138,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Delete user pbx audio
+    # Delete a pbx audio file owned by the authenticated user 
+    # @param conversation_pbx_audio_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxAudioResponse]
+    def delete_user_pbx_audio(conversation_pbx_audio_uuid, opts = {})
+      data, _status_code, _headers = delete_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts)
+      data
+    end
+
+    # Delete user pbx audio
+    # Delete a pbx audio file owned by the authenticated user 
+    # @param conversation_pbx_audio_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxAudioResponse, Integer, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
+    def delete_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.delete_user_pbx_audio ...'
+      end
+      # verify the required parameter 'conversation_pbx_audio_uuid' is set
+      if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.delete_user_pbx_audio"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/audio/user/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', CGI.escape(conversation_pbx_audio_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationPbxAudioResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.delete_user_pbx_audio",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#delete_user_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Agent keep alive
     # Called periodically by the conversation API to keep the session alive. 
     # @param [Hash] opts the optional parameters
@@ -4705,6 +4769,128 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get user pbx audio
+    # Retrieve a pbx audio file owned by the authenticated user 
+    # @param conversation_pbx_audio_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxAudioResponse]
+    def get_user_pbx_audio(conversation_pbx_audio_uuid, opts = {})
+      data, _status_code, _headers = get_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts)
+      data
+    end
+
+    # Get user pbx audio
+    # Retrieve a pbx audio file owned by the authenticated user 
+    # @param conversation_pbx_audio_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxAudioResponse, Integer, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
+    def get_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_user_pbx_audio ...'
+      end
+      # verify the required parameter 'conversation_pbx_audio_uuid' is set
+      if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.get_user_pbx_audio"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/audio/user/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', CGI.escape(conversation_pbx_audio_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationPbxAudioResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_user_pbx_audio",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_user_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get user pbx audios
+    # Retrieve pbx audio files owned by the authenticated user 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxAudiosResponse]
+    def get_user_pbx_audios(opts = {})
+      data, _status_code, _headers = get_user_pbx_audios_with_http_info(opts)
+      data
+    end
+
+    # Get user pbx audios
+    # Retrieve pbx audio files owned by the authenticated user 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxAudiosResponse, Integer, Hash)>] ConversationPbxAudiosResponse data, response status code and response headers
+    def get_user_pbx_audios_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_user_pbx_audios ...'
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/audio/user'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationPbxAudiosResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_user_pbx_audios",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_user_pbx_audios\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get virtual agent budget
     # Retrieve virtual agent budget 
     # @param [Hash] opts the optional parameters
@@ -5799,6 +5985,75 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Insert user pbx audio
+    # Insert a pbx audio file for the authenticated user 
+    # @param pbx_audio [ConversationPbxAudio] Pbx Audio
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxAudioResponse]
+    def insert_user_pbx_audio(pbx_audio, opts = {})
+      data, _status_code, _headers = insert_user_pbx_audio_with_http_info(pbx_audio, opts)
+      data
+    end
+
+    # Insert user pbx audio
+    # Insert a pbx audio file for the authenticated user 
+    # @param pbx_audio [ConversationPbxAudio] Pbx Audio
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxAudioResponse, Integer, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
+    def insert_user_pbx_audio_with_http_info(pbx_audio, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.insert_user_pbx_audio ...'
+      end
+      # verify the required parameter 'pbx_audio' is set
+      if @api_client.config.client_side_validation && pbx_audio.nil?
+        fail ArgumentError, "Missing the required parameter 'pbx_audio' when calling ConversationApi.insert_user_pbx_audio"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/audio/user'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(pbx_audio)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationPbxAudioResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.insert_user_pbx_audio",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#insert_user_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Join a conversation
     # Join a conversation 
     # @param conversation_uuid [String] 
@@ -8042,6 +8297,81 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Update user pbx audio
+    # Update a pbx audio file owned by the authenticated user 
+    # @param conversation_pbx_audio_uuid [String] 
+    # @param pbx_audio [ConversationPbxAudio] Pbx Audio
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationPbxAudioResponse]
+    def update_user_pbx_audio(conversation_pbx_audio_uuid, pbx_audio, opts = {})
+      data, _status_code, _headers = update_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio, opts)
+      data
+    end
+
+    # Update user pbx audio
+    # Update a pbx audio file owned by the authenticated user 
+    # @param conversation_pbx_audio_uuid [String] 
+    # @param pbx_audio [ConversationPbxAudio] Pbx Audio
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationPbxAudioResponse, Integer, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
+    def update_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.update_user_pbx_audio ...'
+      end
+      # verify the required parameter 'conversation_pbx_audio_uuid' is set
+      if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.update_user_pbx_audio"
+      end
+      # verify the required parameter 'pbx_audio' is set
+      if @api_client.config.client_side_validation && pbx_audio.nil?
+        fail ArgumentError, "Missing the required parameter 'pbx_audio' when calling ConversationApi.update_user_pbx_audio"
+      end
+      # resource path
+      local_var_path = '/conversation/pbx/audio/user/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', CGI.escape(conversation_pbx_audio_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(pbx_audio)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationPbxAudioResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.update_user_pbx_audio",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#update_user_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update virtual agent budget
     # Update virtual agent budget 
     # @param virtual_agent_budget [ConversationVirtualAgentBudget] Virtual Agent Budget

data/lib/ultracart_api/api/oauth_api.rb

@@ -40,6 +40,7 @@ module UltracartClient
     # @option opts [String] :code Authorization code received back from the browser redirect
     # @option opts [String] :redirect_uri The URI that you redirect the browser to start the authorization process
     # @option opts [String] :refresh_token The refresh token received during the original grant_type=authorization_code that can be used to return a new access token
+    # @option opts [String] :device_code The device code received from /oauth/device/authorize
     # @return [OauthTokenResponse]
     def oauth_access_token(client_id, grant_type, opts = {})
       data, _status_code, _headers = oauth_access_token_with_http_info(client_id, grant_type, opts)
@@ -54,6 +55,7 @@ module UltracartClient
     # @option opts [String] :code Authorization code received back from the browser redirect
     # @option opts [String] :redirect_uri The URI that you redirect the browser to start the authorization process
     # @option opts [String] :refresh_token The refresh token received during the original grant_type=authorization_code that can be used to return a new access token
+    # @option opts [String] :device_code The device code received from /oauth/device/authorize
     # @return [Array<(OauthTokenResponse, Integer, Hash)>] OauthTokenResponse data, response status code and response headers
     def oauth_access_token_with_http_info(client_id, grant_type, opts = {})
       if @api_client.config.debugging
@@ -91,6 +93,7 @@ module UltracartClient
       form_params['code'] = opts[:'code'] if !opts[:'code'].nil?
       form_params['redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?
       form_params['refresh_token'] = opts[:'refresh_token'] if !opts[:'refresh_token'].nil?
+      form_params['device_code'] = opts[:'device_code'] if !opts[:'device_code'].nil?
 
       # http body (model)
       post_body = opts[:debug_body]
@@ -118,6 +121,83 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Initiate a device authorization flow.
+    # Initiates the device authorization flow by returning a device code and user code. The device displays the user code to the merchant, who visits the verification URI to approve the request. RFC 8628. 
+    # @param client_id [String] The OAuth application client_id.
+    # @param scope [String] The application-level scope (e.g., crm, ultraship).
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def oauth_device_authorize(client_id, scope, opts = {})
+      oauth_device_authorize_with_http_info(client_id, scope, opts)
+      nil
+    end
+
+    # Initiate a device authorization flow.
+    # Initiates the device authorization flow by returning a device code and user code. The device displays the user code to the merchant, who visits the verification URI to approve the request. RFC 8628. 
+    # @param client_id [String] The OAuth application client_id.
+    # @param scope [String] The application-level scope (e.g., crm, ultraship).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def oauth_device_authorize_with_http_info(client_id, scope, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OauthApi.oauth_device_authorize ...'
+      end
+      # verify the required parameter 'client_id' is set
+      if @api_client.config.client_side_validation && client_id.nil?
+        fail ArgumentError, "Missing the required parameter 'client_id' when calling OauthApi.oauth_device_authorize"
+      end
+      # verify the required parameter 'scope' is set
+      if @api_client.config.client_side_validation && scope.nil?
+        fail ArgumentError, "Missing the required parameter 'scope' when calling OauthApi.oauth_device_authorize"
+      end
+      # resource path
+      local_var_path = '/oauth/device/authorize'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['client_id'] = client_id
+      form_params['scope'] = scope
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OauthApi.oauth_device_authorize",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OauthApi#oauth_device_authorize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Revoke this OAuth application.
     # Revokes the OAuth application associated with the specified client_id and token. 
     # @param client_id [String] The OAuth application client_id.