ultracart_api 3.10.46 → 3.10.48

data/lib/ultracart_api/api/conversation_api.rb

@@ -32,6 +32,54 @@ module UltracartClient
       UltracartClient::ConversationApi.new(api_client)
     end
 
+    # Agent keep alive
+    # Called periodically by the conversation API to keep the session alive. 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_agent_keep_alive(opts = {})
+      get_agent_keep_alive_with_http_info(opts)
+      nil
+    end
+
+    # Agent keep alive
+    # Called periodically by the conversation API to keep the session alive. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_agent_keep_alive_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_keep_alive ...'
+      end
+      # resource path
+      local_var_path = '/conversation/agent/keepalive'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_agent_keep_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get agent websocket authorization
     # Retrieve a JWT to authorize an agent to make a websocket connection. 
     # @param [Hash] opts the optional parameters
@@ -85,6 +133,7 @@ module UltracartClient
     # Retrieve a conversation including the participants and messages 
     # @param conversation_uuid 
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 
     # @return [ConversationResponse]
     def get_conversation(conversation_uuid, opts = {})
       data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
@@ -95,6 +144,7 @@ module UltracartClient
     # Retrieve a conversation including the participants and messages 
     # @param conversation_uuid 
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 
     # @return [Array<(ConversationResponse, Fixnum, Hash)>] ConversationResponse data, response status code and response headers
     def get_conversation_with_http_info(conversation_uuid, opts = {})
       if @api_client.config.debugging
@@ -109,6 +159,7 @@ module UltracartClient
 
       # query parameters
       query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = {}
@@ -136,6 +187,70 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve conversation messages
+    # Retrieve conversation messages since a particular time 
+    # @param conversation_uuid 
+    # @param since 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 
+    # @return [ConversationMessagesResponse]
+    def get_conversation_messages(conversation_uuid, since, opts = {})
+      data, _status_code, _headers = get_conversation_messages_with_http_info(conversation_uuid, since, opts)
+      data
+    end
+
+    # Retrieve conversation messages
+    # Retrieve conversation messages since a particular time 
+    # @param conversation_uuid 
+    # @param since 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 
+    # @return [Array<(ConversationMessagesResponse, Fixnum, Hash)>] ConversationMessagesResponse data, response status code and response headers
+    def get_conversation_messages_with_http_info(conversation_uuid, since, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_messages ...'
+      end
+      # verify the required parameter 'conversation_uuid' is set
+      if @api_client.config.client_side_validation && conversation_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_messages"
+      end
+      # verify the required parameter 'since' is set
+      if @api_client.config.client_side_validation && since.nil?
+        fail ArgumentError, "Missing the required parameter 'since' when calling ConversationApi.get_conversation_messages"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/{conversation_uuid}/messages/{since}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s).sub('{' + 'since' + '}', since.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ConversationMessagesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversation_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get a presigned conersation multimedia upload URL
     # Get a presigned conersation multimedia upload URL 
     # @param extension 

data/lib/ultracart_api/api/item_api.rb

@@ -32,6 +32,60 @@ module UltracartClient
       UltracartClient::ItemApi.new(api_client)
     end
 
+    # Delete a digital item, which is a file within the digital library, not an actual merchant item
+    # Delete a digital item on the UltraCart account. 
+    # @param digital_item_oid The digital item oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_digital_item(digital_item_oid, opts = {})
+      delete_digital_item_with_http_info(digital_item_oid, opts)
+      nil
+    end
+
+    # Delete a digital item, which is a file within the digital library, not an actual merchant item
+    # Delete a digital item on the UltraCart account. 
+    # @param digital_item_oid The digital item oid to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_digital_item_with_http_info(digital_item_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.delete_digital_item ...'
+      end
+      # verify the required parameter 'digital_item_oid' is set
+      if @api_client.config.client_side_validation && digital_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item_oid' when calling ItemApi.delete_digital_item"
+      end
+      # resource path
+      local_var_path = '/item/digital_library/{digital_item_oid}'.sub('{' + 'digital_item_oid' + '}', digital_item_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#delete_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Delete an item
     # Delete an item on the UltraCart account. 
     # @param merchant_item_oid The item oid to delete.
@@ -86,6 +140,146 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
+    # Retrieves a digital item (file information) from the account.  Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. 
+    # @param digital_item_oid The digital item oid to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [ItemDigitalItemResponse]
+    def get_digital_item(digital_item_oid, opts = {})
+      data, _status_code, _headers = get_digital_item_with_http_info(digital_item_oid, opts)
+      data
+    end
+
+    # Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
+    # Retrieves a digital item (file information) from the account.  Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. 
+    # @param digital_item_oid The digital item oid to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [Array<(ItemDigitalItemResponse, Fixnum, Hash)>] ItemDigitalItemResponse data, response status code and response headers
+    def get_digital_item_with_http_info(digital_item_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_item ...'
+      end
+      # verify the required parameter 'digital_item_oid' is set
+      if @api_client.config.client_side_validation && digital_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item_oid' when calling ItemApi.get_digital_item"
+      end
+      # resource path
+      local_var_path = '/item/digital_library/{digital_item_oid}'.sub('{' + 'digital_item_oid' + '}', digital_item_oid.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+      query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ItemDigitalItemResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#get_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve digital items from the digital library which are digital files that may be attached to normal items
+    # Retrieves a group of digital items (file information) from the account.  If no parameters are specified, all digital items will be returned.  Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [ItemDigitalItemsResponse]
+    def get_digital_items(opts = {})
+      data, _status_code, _headers = get_digital_items_with_http_info(opts)
+      data
+    end
+
+    # Retrieve digital items from the digital library which are digital files that may be attached to normal items
+    # Retrieves a group of digital items (file information) from the account.  If no parameters are specified, all digital items will be returned.  Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [Array<(ItemDigitalItemsResponse, Fixnum, Hash)>] ItemDigitalItemsResponse data, response status code and response headers
+    def get_digital_items_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_items ...'
+      end
+      # resource path
+      local_var_path = '/item/digital_library'
+
+      # query parameters
+      query_params = {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+      query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ItemDigitalItemsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#get_digital_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve an item
     # Retrieves a single item using the specified item oid. 
     # @param merchant_item_oid The item oid to retrieve.
@@ -333,6 +527,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Create a file within the digital library
+    # Create a file within the digital library.  This does not create an item, but makes this digital file available and selectable as part (or all) of an item. 
+    # @param digital_item Digital item to create
+    # @param [Hash] opts the optional parameters
+    # @return [ItemDigitalItemResponse]
+    def insert_digital_item(digital_item, opts = {})
+      data, _status_code, _headers = insert_digital_item_with_http_info(digital_item, opts)
+      data
+    end
+
+    # Create a file within the digital library
+    # Create a file within the digital library.  This does not create an item, but makes this digital file available and selectable as part (or all) of an item. 
+    # @param digital_item Digital item to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemDigitalItemResponse, Fixnum, Hash)>] ItemDigitalItemResponse data, response status code and response headers
+    def insert_digital_item_with_http_info(digital_item, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.insert_digital_item ...'
+      end
+      # verify the required parameter 'digital_item' is set
+      if @api_client.config.client_side_validation && digital_item.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item' when calling ItemApi.insert_digital_item"
+      end
+      # resource path
+      local_var_path = '/item/digital_library'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(digital_item)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ItemDigitalItemResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#insert_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Create an item
     # Create a new item on the UltraCart account. 
     # @param item Item to create
@@ -394,6 +643,67 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Updates a file within the digital library
+    # Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
+    # @param digital_item_oid The digital item oid to update.
+    # @param digital_item Digital item to update
+    # @param [Hash] opts the optional parameters
+    # @return [ItemDigitalItemResponse]
+    def update_digital_item(digital_item_oid, digital_item, opts = {})
+      data, _status_code, _headers = update_digital_item_with_http_info(digital_item_oid, digital_item, opts)
+      data
+    end
+
+    # Updates a file within the digital library
+    # Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
+    # @param digital_item_oid The digital item oid to update.
+    # @param digital_item Digital item to update
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemDigitalItemResponse, Fixnum, Hash)>] ItemDigitalItemResponse data, response status code and response headers
+    def update_digital_item_with_http_info(digital_item_oid, digital_item, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.update_digital_item ...'
+      end
+      # verify the required parameter 'digital_item_oid' is set
+      if @api_client.config.client_side_validation && digital_item_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item_oid' when calling ItemApi.update_digital_item"
+      end
+      # verify the required parameter 'digital_item' is set
+      if @api_client.config.client_side_validation && digital_item.nil?
+        fail ArgumentError, "Missing the required parameter 'digital_item' when calling ItemApi.update_digital_item"
+      end
+      # resource path
+      local_var_path = '/item/digital_library/{digital_item_oid}'.sub('{' + 'digital_item_oid' + '}', digital_item_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(digital_item)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ItemDigitalItemResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#update_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update an item
     # Update a new item on the UltraCart account. 
     # @param item Item to update