recombee_api_client 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c24717b90f3a557ec2ceda5bf24f0c62f1ae80384b0a993c7545c156b8586ddd
-  data.tar.gz: d1a88f7d65d7dc7456068975263d435d06059838d9e8c4a1deedf9cbce42e8c8
+  metadata.gz: 993911797068c239b3eb1ed0bff4f115049a3a7c5c25cc10ee2e7606fabaecc5
+  data.tar.gz: 9759c4ad279ea317cbdf0d6b3ac93eee89761010b1d8aded8cdd946f9dc0e793
 SHA512:
-  metadata.gz: 6b33bd56d774de4240d04decbc4752b7c506062b26519b1d9e5afb335a61603bd2ba6723faeea545fe773cd659f54fb72490bafe66a112b6b31438eb7d2b0f6f
-  data.tar.gz: 1ea09e4189c88f8aa13f2e35ba36c1792da8877ae40ee1ca787f2f414ebc1da149f3557c0f26c09575106b25ec8019692d4b83e1ae1de88dce22574bdab8051c
+  metadata.gz: 7a5cccd32d72f4ec654b3ffc9c8f9d0f50e90618b104afc7618e24cf40f0ad9ceaf14b18031d7e8c4ef1ac05027a7857a592e3fc18fded5a7a2f1b27b80f9225
+  data.tar.gz: 8a68e11edd23890854ec6248994d77e4f494fd19b881d798eb7f916b0823b77987695ad0c439594fdadc82c7f229cda3128ce6d3dfecdd17162e38654d1f3200

data/lib/recombee_api_client.rb

@@ -18,7 +18,7 @@ module RecombeeApiClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/3.1.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/3.2.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee

data/lib/recombee_api_client/api/add_search_synonym.rb

@@ -0,0 +1,72 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
+  #
+  #When the `term` is used in the search query, the `synonym` is also used for the full-text search.
+  #Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
+  #
+  #An example of a synonym can be `science fiction` for the term `sci-fi`.
+  #
+  class AddSearchSynonym < ApiRequest
+    attr_reader :term, :synonym, :one_way
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +term+ -> A word to which the `synonym` is specified.
+  #   - +synonym+ -> A word that should be considered equal to the `term` by the full-text search engine.
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +oneWay+ -> If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
+  #
+  #Default: `false`.
+  #
+  #
+    def initialize(term, synonym, optional = {})
+      @term = term
+      @synonym = synonym
+      optional = normalize_optional(optional)
+      @one_way = optional['oneWay']
+      @optional = optional
+      @timeout = 10000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["oneWay"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['term'] = @term
+      p['synonym'] = @synonym
+      p['oneWay'] = @optional['oneWay'] if @optional.include? 'oneWay'
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/synonyms/items/"
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_all_search_synonyms.rb

@@ -0,0 +1,47 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes all synonyms defined in the database.
+  #
+  class DeleteAllSearchSynonyms < ApiRequest
+  
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  #
+    def initialize()
+      @timeout = 10000
+      @ensure_https = false
+    end
+  
+    # HTTP method
+    def method
+      :delete
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/synonyms/items/"
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_search_synonym.rb

@@ -0,0 +1,50 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes synonym of given `id` and this synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
+  #
+  class DeleteSearchSynonym < ApiRequest
+    attr_reader :id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +id+ -> ID of the synonym that should be deleted.
+  #
+    def initialize(id)
+      @id = id
+      @timeout = 10000
+      @ensure_https = false
+    end
+  
+    # HTTP method
+    def method
+      :delete
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/synonyms/items/#{@id}"
+    end
+  end
+end

data/lib/recombee_api_client/api/list_search_synonyms.rb

@@ -0,0 +1,59 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Gives the list of synonyms defined in the database.
+  class ListSearchSynonyms < ApiRequest
+    attr_reader :count, :offset
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +count+ -> The number of synonyms to be listed.
+  #   - +offset+ -> Specifies the number of synonyms to skip (ordered by `term`).
+  #
+    def initialize(optional = {})
+      optional = normalize_optional(optional)
+      @count = optional['count']
+      @offset = optional['offset']
+      @optional = optional
+      @timeout = 100000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["count","offset"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :get
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params['count'] = @optional['count'] if @optional['count']
+      params['offset'] = @optional['offset'] if @optional['offset']
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/synonyms/items/"
+    end
+  end
+end

data/lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Ondřej Fiedler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -100,10 +100,12 @@ files:
 - lib/recombee_api_client/api/add_item_property.rb
 - lib/recombee_api_client/api/add_purchase.rb
 - lib/recombee_api_client/api/add_rating.rb
+- lib/recombee_api_client/api/add_search_synonym.rb
 - lib/recombee_api_client/api/add_series.rb
 - lib/recombee_api_client/api/add_user.rb
 - lib/recombee_api_client/api/add_user_property.rb
 - lib/recombee_api_client/api/batch.rb
+- lib/recombee_api_client/api/delete_all_search_synonyms.rb
 - lib/recombee_api_client/api/delete_bookmark.rb
 - lib/recombee_api_client/api/delete_cart_addition.rb
 - lib/recombee_api_client/api/delete_detail_view.rb
@@ -112,6 +114,7 @@ files:
 - lib/recombee_api_client/api/delete_item_property.rb
 - lib/recombee_api_client/api/delete_purchase.rb
 - lib/recombee_api_client/api/delete_rating.rb
+- lib/recombee_api_client/api/delete_search_synonym.rb
 - lib/recombee_api_client/api/delete_series.rb
 - lib/recombee_api_client/api/delete_user.rb
 - lib/recombee_api_client/api/delete_user_property.rb
@@ -134,6 +137,7 @@ files:
 - lib/recombee_api_client/api/list_item_ratings.rb
 - lib/recombee_api_client/api/list_item_view_portions.rb
 - lib/recombee_api_client/api/list_items.rb
+- lib/recombee_api_client/api/list_search_synonyms.rb
 - lib/recombee_api_client/api/list_series.rb
 - lib/recombee_api_client/api/list_series_items.rb
 - lib/recombee_api_client/api/list_user_bookmarks.rb