class Wallee::CustomerCommentService
Attributes
Public Class Methods
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 24 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Count Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Integer]
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 34 def count(space_id, opts = {}) data, _status_code, _headers = count_with_http_info(space_id, opts) return data end
Count Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Array<(Integer, Fixnum, Hash)>] Integer data, response status code and response headers
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 45 def count_with_http_info(space_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CustomerCommentService.count ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling CustomerCommentService.count" if space_id.nil? # resource path local_var_path = "/customer-comment/count".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] 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;charset=utf-8'] 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(opts[:'filter']) auth_names = [] 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 => 'Integer') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomerCommentService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create Creates the entity with the given properties. @param space_id @param entity The customer object which should be created. @param [Hash] opts the optional parameters @return [CustomerComment]
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 94 def create(space_id, entity, opts = {}) data, _status_code, _headers = create_with_http_info(space_id, entity, opts) return data end
Create Creates the entity with the given properties. @param space_id @param entity The customer object which should be created. @param [Hash] opts the optional parameters @return [Array<(CustomerComment
, Fixnum, Hash)>] CustomerComment
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 105 def create_with_http_info(space_id, entity, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CustomerCommentService.create ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling CustomerCommentService.create" if space_id.nil? # verify the required parameter 'entity' is set fail ArgumentError, "Missing the required parameter 'entity' when calling CustomerCommentService.create" if entity.nil? # resource path local_var_path = "/customer-comment/create".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] 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;charset=utf-8'] 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(entity) auth_names = [] 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 => 'CustomerComment') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomerCommentService#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Deletes the entity with the given id. @param space_id @param id @param [Hash] opts the optional parameters @return [nil]
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 156 def delete(space_id, id, opts = {}) delete_with_http_info(space_id, id, opts) return nil end
Delete Deletes the entity with the given id. @param space_id @param id @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 167 def delete_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CustomerCommentService.delete ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling CustomerCommentService.delete" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling CustomerCommentService.delete" if id.nil? # resource path local_var_path = "/customer-comment/delete".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] 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;charset=utf-8'] 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(id) auth_names = [] 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomerCommentService#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
pinComment
@param space_id @param id The id of the customer comment to pin to the top. @param [Hash] opts the optional parameters @return [nil]
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 217 def pin_comment(space_id, id, opts = {}) pin_comment_with_http_info(space_id, id, opts) return nil end
pinComment
@param space_id @param id The id of the customer comment to pin to the top. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 228 def pin_comment_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CustomerCommentService.pin_comment ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling CustomerCommentService.pin_comment" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling CustomerCommentService.pin_comment" if id.nil? # resource path local_var_path = "/customer-comment/pin-comment".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'id'] = id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] 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 = ['*/*'] 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 = [] 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: CustomerCommentService#pin_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Read Reads the entity with the given 'id' and returns it. @param space_id @param id The id of the customer which should be returned. @param [Hash] opts the optional parameters @return [CustomerComment]
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 279 def read(space_id, id, opts = {}) data, _status_code, _headers = read_with_http_info(space_id, id, opts) return data end
Read Reads the entity with the given 'id' and returns it. @param space_id @param id The id of the customer which should be returned. @param [Hash] opts the optional parameters @return [Array<(CustomerComment
, Fixnum, Hash)>] CustomerComment
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 290 def read_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CustomerCommentService.read ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling CustomerCommentService.read" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling CustomerCommentService.read" if id.nil? # resource path local_var_path = "/customer-comment/read".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'id'] = id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] 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 = ['*/*'] 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 = [] 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 => 'CustomerComment') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomerCommentService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search Searches for the entities as specified by the given query. @param space_id @param query The query restricts the customers which are returned by the search. @param [Hash] opts the optional parameters @return [Array<CustomerComment>]
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 342 def search(space_id, query, opts = {}) data, _status_code, _headers = search_with_http_info(space_id, query, opts) return data end
Search Searches for the entities as specified by the given query. @param space_id @param query The query restricts the customers which are returned by the search. @param [Hash] opts the optional parameters @return [Array<(Array<CustomerComment>, Fixnum, Hash)>] Array<CustomerComment> data, response status code and response headers
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 353 def search_with_http_info(space_id, query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CustomerCommentService.search ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling CustomerCommentService.search" if space_id.nil? # verify the required parameter 'query' is set fail ArgumentError, "Missing the required parameter 'query' when calling CustomerCommentService.search" if query.nil? # resource path local_var_path = "/customer-comment/search".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] 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;charset=utf-8'] 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(query) auth_names = [] 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 => 'Array<CustomerComment>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomerCommentService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
unpinComment
@param space_id @param id The id of the customer comment to unpin. @param [Hash] opts the optional parameters @return [nil]
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 404 def unpin_comment(space_id, id, opts = {}) unpin_comment_with_http_info(space_id, id, opts) return nil end
unpinComment
@param space_id @param id The id of the customer comment to unpin. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 415 def unpin_comment_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CustomerCommentService.unpin_comment ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling CustomerCommentService.unpin_comment" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling CustomerCommentService.unpin_comment" if id.nil? # resource path local_var_path = "/customer-comment/unpin-comment".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'id'] = id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] 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 = ['*/*'] 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 = [] 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: CustomerCommentService#unpin_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity. @param space_id @param entity The customer object with the properties which should be updated. @param [Hash] opts the optional parameters @return [CustomerComment]
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 466 def update(space_id, entity, opts = {}) data, _status_code, _headers = update_with_http_info(space_id, entity, opts) return data end
Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity. @param space_id @param entity The customer object with the properties which should be updated. @param [Hash] opts the optional parameters @return [Array<(CustomerComment
, Fixnum, Hash)>] CustomerComment
data, response status code and response headers
# File lib/wallee-ruby-sdk/api/customer_comment_service_api.rb, line 477 def update_with_http_info(space_id, entity, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CustomerCommentService.update ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling CustomerCommentService.update" if space_id.nil? # verify the required parameter 'entity' is set fail ArgumentError, "Missing the required parameter 'entity' when calling CustomerCommentService.update" if entity.nil? # resource path local_var_path = "/customer-comment/update".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] 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;charset=utf-8'] 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(entity) auth_names = [] 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 => 'CustomerComment') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomerCommentService#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end