recombee_api_client 4.0.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/lib/recombee_api_client/api/add_bookmark.rb +2 -2
- data/lib/recombee_api_client/api/add_cart_addition.rb +4 -4
- data/lib/recombee_api_client/api/add_detail_view.rb +2 -2
- data/lib/recombee_api_client/api/add_item.rb +3 -3
- data/lib/recombee_api_client/api/add_item_property.rb +2 -2
- data/lib/recombee_api_client/api/add_manual_reql_segment.rb +69 -0
- data/lib/recombee_api_client/api/add_purchase.rb +5 -5
- data/lib/recombee_api_client/api/add_rating.rb +2 -2
- data/lib/recombee_api_client/api/add_series.rb +14 -4
- data/lib/recombee_api_client/api/add_user.rb +1 -1
- data/lib/recombee_api_client/api/add_user_property.rb +2 -2
- data/lib/recombee_api_client/api/create_auto_reql_segmentation.rb +75 -0
- data/lib/recombee_api_client/api/create_manual_reql_segmentation.rb +71 -0
- data/lib/recombee_api_client/api/create_property_based_segmentation.rb +76 -0
- data/lib/recombee_api_client/api/delete_bookmark.rb +4 -4
- data/lib/recombee_api_client/api/delete_cart_addition.rb +4 -4
- data/lib/recombee_api_client/api/delete_detail_view.rb +4 -4
- data/lib/recombee_api_client/api/delete_item.rb +3 -3
- data/lib/recombee_api_client/api/{list_groups.rb → delete_manual_reql_segment.rb} +13 -7
- data/lib/recombee_api_client/api/delete_more_items.rb +4 -4
- data/lib/recombee_api_client/api/delete_purchase.rb +4 -4
- data/lib/recombee_api_client/api/delete_rating.rb +3 -3
- data/lib/recombee_api_client/api/delete_search_synonym.rb +1 -1
- data/lib/recombee_api_client/api/{add_group.rb → delete_segmentation.rb} +10 -9
- data/lib/recombee_api_client/api/delete_series.rb +14 -4
- data/lib/recombee_api_client/api/delete_user.rb +2 -2
- data/lib/recombee_api_client/api/delete_user_property.rb +1 -1
- data/lib/recombee_api_client/api/delete_view_portion.rb +1 -1
- data/lib/recombee_api_client/api/get_item_property_info.rb +1 -1
- data/lib/recombee_api_client/api/get_item_values.rb +3 -3
- data/lib/recombee_api_client/api/{list_group_items.rb → get_segmentation.rb} +9 -8
- data/lib/recombee_api_client/api/get_user_values.rb +3 -3
- data/lib/recombee_api_client/api/insert_to_series.rb +3 -3
- data/lib/recombee_api_client/api/list_item_bookmarks.rb +2 -2
- data/lib/recombee_api_client/api/list_item_cart_additions.rb +2 -2
- data/lib/recombee_api_client/api/list_item_detail_views.rb +2 -2
- data/lib/recombee_api_client/api/list_item_purchases.rb +2 -2
- data/lib/recombee_api_client/api/list_item_ratings.rb +2 -2
- data/lib/recombee_api_client/api/list_item_view_portions.rb +2 -2
- data/lib/recombee_api_client/api/list_items.rb +1 -1
- data/lib/recombee_api_client/api/{delete_group.rb → list_segmentations.rb} +10 -11
- data/lib/recombee_api_client/api/list_series_items.rb +2 -2
- data/lib/recombee_api_client/api/list_user_bookmarks.rb +1 -1
- data/lib/recombee_api_client/api/list_user_cart_additions.rb +1 -1
- data/lib/recombee_api_client/api/list_user_detail_views.rb +1 -1
- data/lib/recombee_api_client/api/list_user_purchases.rb +1 -1
- data/lib/recombee_api_client/api/list_user_ratings.rb +1 -1
- data/lib/recombee_api_client/api/list_user_view_portions.rb +1 -1
- data/lib/recombee_api_client/api/list_users.rb +1 -1
- data/lib/recombee_api_client/api/merge_users.rb +2 -2
- data/lib/recombee_api_client/api/recommend_item_segments_to_item.rb +131 -0
- data/lib/recombee_api_client/api/recommend_item_segments_to_item_segment.rb +131 -0
- data/lib/recombee_api_client/api/recommend_item_segments_to_user.rb +111 -0
- data/lib/recombee_api_client/api/recommend_items_to_item.rb +26 -26
- data/lib/recombee_api_client/api/recommend_items_to_item_segment.rb +207 -0
- data/lib/recombee_api_client/api/recommend_items_to_user.rb +23 -23
- data/lib/recombee_api_client/api/recommend_next_items.rb +2 -2
- data/lib/recombee_api_client/api/recommend_users_to_item.rb +18 -18
- data/lib/recombee_api_client/api/recommend_users_to_user.rb +21 -21
- data/lib/recombee_api_client/api/remove_from_series.rb +5 -8
- data/lib/recombee_api_client/api/reset_database.rb +1 -1
- data/lib/recombee_api_client/api/search_item_segments.rb +114 -0
- data/lib/recombee_api_client/api/search_items.rb +17 -17
- data/lib/recombee_api_client/api/set_view_portion.rb +4 -4
- data/lib/recombee_api_client/api/update_auto_reql_segmentation.rb +69 -0
- data/lib/recombee_api_client/api/update_manual_reql_segment.rb +67 -0
- data/lib/recombee_api_client/api/update_manual_reql_segmentation.rb +65 -0
- data/lib/recombee_api_client/api/update_more_items.rb +4 -4
- data/lib/recombee_api_client/api/update_property_based_segmentation.rb +69 -0
- data/lib/recombee_api_client/version.rb +1 -1
- data/lib/recombee_api_client.rb +1 -1
- data/recombee_api_client.gemspec +10 -8
- metadata +40 -31
- data/lib/recombee_api_client/api/insert_to_group.rb +0 -66
- data/lib/recombee_api_client/api/remove_from_group.rb +0 -55
metadata
CHANGED
@@ -1,86 +1,86 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: recombee_api_client
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 5.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ondřej Fiedler
|
8
|
-
autorequire:
|
9
8
|
bindir: bin
|
10
9
|
cert_chain: []
|
11
|
-
date:
|
10
|
+
date: 2025-01-14 00:00:00.000000000 Z
|
12
11
|
dependencies:
|
13
12
|
- !ruby/object:Gem::Dependency
|
14
13
|
name: multi_json
|
15
14
|
requirement: !ruby/object:Gem::Requirement
|
16
15
|
requirements:
|
17
|
-
- - "
|
16
|
+
- - "~>"
|
18
17
|
- !ruby/object:Gem::Version
|
19
|
-
version: '
|
18
|
+
version: '1.15'
|
20
19
|
type: :runtime
|
21
20
|
prerelease: false
|
22
21
|
version_requirements: !ruby/object:Gem::Requirement
|
23
22
|
requirements:
|
24
|
-
- - "
|
23
|
+
- - "~>"
|
25
24
|
- !ruby/object:Gem::Version
|
26
|
-
version: '
|
25
|
+
version: '1.15'
|
27
26
|
- !ruby/object:Gem::Dependency
|
28
27
|
name: httparty
|
29
28
|
requirement: !ruby/object:Gem::Requirement
|
30
29
|
requirements:
|
31
|
-
- - "
|
30
|
+
- - "~>"
|
32
31
|
- !ruby/object:Gem::Version
|
33
|
-
version: '0'
|
32
|
+
version: '0.18'
|
34
33
|
type: :runtime
|
35
34
|
prerelease: false
|
36
35
|
version_requirements: !ruby/object:Gem::Requirement
|
37
36
|
requirements:
|
38
|
-
- - "
|
37
|
+
- - "~>"
|
39
38
|
- !ruby/object:Gem::Version
|
40
|
-
version: '0'
|
39
|
+
version: '0.18'
|
41
40
|
- !ruby/object:Gem::Dependency
|
42
41
|
name: bundler
|
43
42
|
requirement: !ruby/object:Gem::Requirement
|
44
43
|
requirements:
|
45
44
|
- - "~>"
|
46
45
|
- !ruby/object:Gem::Version
|
47
|
-
version: 2.2
|
46
|
+
version: 2.6.2
|
48
47
|
type: :development
|
49
48
|
prerelease: false
|
50
49
|
version_requirements: !ruby/object:Gem::Requirement
|
51
50
|
requirements:
|
52
51
|
- - "~>"
|
53
52
|
- !ruby/object:Gem::Version
|
54
|
-
version: 2.2
|
53
|
+
version: 2.6.2
|
55
54
|
- !ruby/object:Gem::Dependency
|
56
55
|
name: rake
|
57
56
|
requirement: !ruby/object:Gem::Requirement
|
58
57
|
requirements:
|
59
58
|
- - "~>"
|
60
59
|
- !ruby/object:Gem::Version
|
61
|
-
version:
|
60
|
+
version: '13.0'
|
62
61
|
type: :development
|
63
62
|
prerelease: false
|
64
63
|
version_requirements: !ruby/object:Gem::Requirement
|
65
64
|
requirements:
|
66
65
|
- - "~>"
|
67
66
|
- !ruby/object:Gem::Version
|
68
|
-
version:
|
67
|
+
version: '13.0'
|
69
68
|
- !ruby/object:Gem::Dependency
|
70
69
|
name: rspec
|
71
70
|
requirement: !ruby/object:Gem::Requirement
|
72
71
|
requirements:
|
73
|
-
- - "
|
72
|
+
- - "~>"
|
74
73
|
- !ruby/object:Gem::Version
|
75
|
-
version: '
|
74
|
+
version: '3.11'
|
76
75
|
type: :development
|
77
76
|
prerelease: false
|
78
77
|
version_requirements: !ruby/object:Gem::Requirement
|
79
78
|
requirements:
|
80
|
-
- - "
|
79
|
+
- - "~>"
|
81
80
|
- !ruby/object:Gem::Version
|
82
|
-
version: '
|
83
|
-
description:
|
81
|
+
version: '3.11'
|
82
|
+
description: A Ruby client for accessing the Recombee recommendation API. Supports
|
83
|
+
personalization and search capabilities with ease.
|
84
84
|
email:
|
85
85
|
- ondrej.fiedler@recombee.com
|
86
86
|
executables: []
|
@@ -95,9 +95,9 @@ files:
|
|
95
95
|
- lib/recombee_api_client/api/add_bookmark.rb
|
96
96
|
- lib/recombee_api_client/api/add_cart_addition.rb
|
97
97
|
- lib/recombee_api_client/api/add_detail_view.rb
|
98
|
-
- lib/recombee_api_client/api/add_group.rb
|
99
98
|
- lib/recombee_api_client/api/add_item.rb
|
100
99
|
- lib/recombee_api_client/api/add_item_property.rb
|
100
|
+
- lib/recombee_api_client/api/add_manual_reql_segment.rb
|
101
101
|
- lib/recombee_api_client/api/add_purchase.rb
|
102
102
|
- lib/recombee_api_client/api/add_rating.rb
|
103
103
|
- lib/recombee_api_client/api/add_search_synonym.rb
|
@@ -105,30 +105,32 @@ files:
|
|
105
105
|
- lib/recombee_api_client/api/add_user.rb
|
106
106
|
- lib/recombee_api_client/api/add_user_property.rb
|
107
107
|
- lib/recombee_api_client/api/batch.rb
|
108
|
+
- lib/recombee_api_client/api/create_auto_reql_segmentation.rb
|
109
|
+
- lib/recombee_api_client/api/create_manual_reql_segmentation.rb
|
110
|
+
- lib/recombee_api_client/api/create_property_based_segmentation.rb
|
108
111
|
- lib/recombee_api_client/api/delete_all_search_synonyms.rb
|
109
112
|
- lib/recombee_api_client/api/delete_bookmark.rb
|
110
113
|
- lib/recombee_api_client/api/delete_cart_addition.rb
|
111
114
|
- lib/recombee_api_client/api/delete_detail_view.rb
|
112
|
-
- lib/recombee_api_client/api/delete_group.rb
|
113
115
|
- lib/recombee_api_client/api/delete_item.rb
|
114
116
|
- lib/recombee_api_client/api/delete_item_property.rb
|
117
|
+
- lib/recombee_api_client/api/delete_manual_reql_segment.rb
|
115
118
|
- lib/recombee_api_client/api/delete_more_items.rb
|
116
119
|
- lib/recombee_api_client/api/delete_purchase.rb
|
117
120
|
- lib/recombee_api_client/api/delete_rating.rb
|
118
121
|
- lib/recombee_api_client/api/delete_search_synonym.rb
|
122
|
+
- lib/recombee_api_client/api/delete_segmentation.rb
|
119
123
|
- lib/recombee_api_client/api/delete_series.rb
|
120
124
|
- lib/recombee_api_client/api/delete_user.rb
|
121
125
|
- lib/recombee_api_client/api/delete_user_property.rb
|
122
126
|
- lib/recombee_api_client/api/delete_view_portion.rb
|
123
127
|
- lib/recombee_api_client/api/get_item_property_info.rb
|
124
128
|
- lib/recombee_api_client/api/get_item_values.rb
|
129
|
+
- lib/recombee_api_client/api/get_segmentation.rb
|
125
130
|
- lib/recombee_api_client/api/get_user_property_info.rb
|
126
131
|
- lib/recombee_api_client/api/get_user_values.rb
|
127
132
|
- lib/recombee_api_client/api/hash_normalizer.rb
|
128
|
-
- lib/recombee_api_client/api/insert_to_group.rb
|
129
133
|
- lib/recombee_api_client/api/insert_to_series.rb
|
130
|
-
- lib/recombee_api_client/api/list_group_items.rb
|
131
|
-
- lib/recombee_api_client/api/list_groups.rb
|
132
134
|
- lib/recombee_api_client/api/list_item_bookmarks.rb
|
133
135
|
- lib/recombee_api_client/api/list_item_cart_additions.rb
|
134
136
|
- lib/recombee_api_client/api/list_item_detail_views.rb
|
@@ -138,6 +140,7 @@ files:
|
|
138
140
|
- lib/recombee_api_client/api/list_item_view_portions.rb
|
139
141
|
- lib/recombee_api_client/api/list_items.rb
|
140
142
|
- lib/recombee_api_client/api/list_search_synonyms.rb
|
143
|
+
- lib/recombee_api_client/api/list_segmentations.rb
|
141
144
|
- lib/recombee_api_client/api/list_series.rb
|
142
145
|
- lib/recombee_api_client/api/list_series_items.rb
|
143
146
|
- lib/recombee_api_client/api/list_user_bookmarks.rb
|
@@ -149,29 +152,36 @@ files:
|
|
149
152
|
- lib/recombee_api_client/api/list_user_view_portions.rb
|
150
153
|
- lib/recombee_api_client/api/list_users.rb
|
151
154
|
- lib/recombee_api_client/api/merge_users.rb
|
155
|
+
- lib/recombee_api_client/api/recommend_item_segments_to_item.rb
|
156
|
+
- lib/recombee_api_client/api/recommend_item_segments_to_item_segment.rb
|
157
|
+
- lib/recombee_api_client/api/recommend_item_segments_to_user.rb
|
152
158
|
- lib/recombee_api_client/api/recommend_items_to_item.rb
|
159
|
+
- lib/recombee_api_client/api/recommend_items_to_item_segment.rb
|
153
160
|
- lib/recombee_api_client/api/recommend_items_to_user.rb
|
154
161
|
- lib/recombee_api_client/api/recommend_next_items.rb
|
155
162
|
- lib/recombee_api_client/api/recommend_users_to_item.rb
|
156
163
|
- lib/recombee_api_client/api/recommend_users_to_user.rb
|
157
|
-
- lib/recombee_api_client/api/remove_from_group.rb
|
158
164
|
- lib/recombee_api_client/api/remove_from_series.rb
|
159
165
|
- lib/recombee_api_client/api/request.rb
|
160
166
|
- lib/recombee_api_client/api/reset_database.rb
|
167
|
+
- lib/recombee_api_client/api/search_item_segments.rb
|
161
168
|
- lib/recombee_api_client/api/search_items.rb
|
162
169
|
- lib/recombee_api_client/api/set_item_values.rb
|
163
170
|
- lib/recombee_api_client/api/set_user_values.rb
|
164
171
|
- lib/recombee_api_client/api/set_values.rb
|
165
172
|
- lib/recombee_api_client/api/set_view_portion.rb
|
173
|
+
- lib/recombee_api_client/api/update_auto_reql_segmentation.rb
|
174
|
+
- lib/recombee_api_client/api/update_manual_reql_segment.rb
|
175
|
+
- lib/recombee_api_client/api/update_manual_reql_segmentation.rb
|
166
176
|
- lib/recombee_api_client/api/update_more_items.rb
|
177
|
+
- lib/recombee_api_client/api/update_property_based_segmentation.rb
|
167
178
|
- lib/recombee_api_client/errors.rb
|
168
179
|
- lib/recombee_api_client/version.rb
|
169
180
|
- recombee_api_client.gemspec
|
170
|
-
homepage:
|
181
|
+
homepage: https://recombee.com
|
171
182
|
licenses:
|
172
183
|
- MIT
|
173
184
|
metadata: {}
|
174
|
-
post_install_message:
|
175
185
|
rdoc_options: []
|
176
186
|
require_paths:
|
177
187
|
- lib
|
@@ -179,15 +189,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
179
189
|
requirements:
|
180
190
|
- - ">="
|
181
191
|
- !ruby/object:Gem::Version
|
182
|
-
version:
|
192
|
+
version: 2.5.0
|
183
193
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
184
194
|
requirements:
|
185
195
|
- - ">="
|
186
196
|
- !ruby/object:Gem::Version
|
187
197
|
version: '0'
|
188
198
|
requirements: []
|
189
|
-
rubygems_version: 3.
|
190
|
-
signing_key:
|
199
|
+
rubygems_version: 3.6.2
|
191
200
|
specification_version: 4
|
192
201
|
summary: Client for Recombee recommendation API
|
193
202
|
test_files: []
|
@@ -1,66 +0,0 @@
|
|
1
|
-
#
|
2
|
-
# This file is auto-generated, do not edit
|
3
|
-
#
|
4
|
-
|
5
|
-
module RecombeeApiClient
|
6
|
-
require_relative 'request'
|
7
|
-
require_relative '../errors'
|
8
|
-
|
9
|
-
##
|
10
|
-
#Inserts an existing item/group into group of given `groupId`.
|
11
|
-
#
|
12
|
-
class InsertToGroup < ApiRequest
|
13
|
-
attr_reader :group_id, :item_type, :item_id, :cascade_create
|
14
|
-
attr_accessor :timeout
|
15
|
-
attr_accessor :ensure_https
|
16
|
-
|
17
|
-
##
|
18
|
-
# * *Required arguments*
|
19
|
-
# - +group_id+ -> ID of the group to be inserted into.
|
20
|
-
# - +item_type+ -> `item` iff the regular item from the catalog is to be inserted, `group` iff group is inserted as the item.
|
21
|
-
# - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.
|
22
|
-
#
|
23
|
-
# * *Optional arguments (given as hash optional)*
|
24
|
-
# - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.
|
25
|
-
#
|
26
|
-
def initialize(group_id, item_type, item_id, optional = {})
|
27
|
-
@group_id = group_id
|
28
|
-
@item_type = item_type
|
29
|
-
@item_id = item_id
|
30
|
-
optional = normalize_optional(optional)
|
31
|
-
@cascade_create = optional['cascadeCreate']
|
32
|
-
@optional = optional
|
33
|
-
@timeout = 1000
|
34
|
-
@ensure_https = false
|
35
|
-
@optional.each do |par, _|
|
36
|
-
fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
|
37
|
-
end
|
38
|
-
end
|
39
|
-
|
40
|
-
# HTTP method
|
41
|
-
def method
|
42
|
-
:post
|
43
|
-
end
|
44
|
-
|
45
|
-
# Values of body parameters as a Hash
|
46
|
-
def body_parameters
|
47
|
-
p = Hash.new
|
48
|
-
p['itemType'] = @item_type
|
49
|
-
p['itemId'] = @item_id
|
50
|
-
p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
|
51
|
-
p
|
52
|
-
end
|
53
|
-
|
54
|
-
# Values of query parameters as a Hash.
|
55
|
-
# name of parameter => value of the parameter
|
56
|
-
def query_parameters
|
57
|
-
params = {}
|
58
|
-
params
|
59
|
-
end
|
60
|
-
|
61
|
-
# Relative path to the endpoint
|
62
|
-
def path
|
63
|
-
"/{databaseId}/groups/#{@group_id}/items/"
|
64
|
-
end
|
65
|
-
end
|
66
|
-
end
|
@@ -1,55 +0,0 @@
|
|
1
|
-
#
|
2
|
-
# This file is auto-generated, do not edit
|
3
|
-
#
|
4
|
-
|
5
|
-
module RecombeeApiClient
|
6
|
-
require_relative 'request'
|
7
|
-
require_relative '../errors'
|
8
|
-
|
9
|
-
##
|
10
|
-
#Removes an existing group item from the group.
|
11
|
-
class RemoveFromGroup < ApiRequest
|
12
|
-
attr_reader :group_id, :item_type, :item_id
|
13
|
-
attr_accessor :timeout
|
14
|
-
attr_accessor :ensure_https
|
15
|
-
|
16
|
-
##
|
17
|
-
# * *Required arguments*
|
18
|
-
# - +group_id+ -> ID of the group from which a group item is to be removed.
|
19
|
-
# - +item_type+ -> Type of the item to be removed.
|
20
|
-
# - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.
|
21
|
-
#
|
22
|
-
def initialize(group_id, item_type, item_id)
|
23
|
-
@group_id = group_id
|
24
|
-
@item_type = item_type
|
25
|
-
@item_id = item_id
|
26
|
-
@timeout = 1000
|
27
|
-
@ensure_https = false
|
28
|
-
end
|
29
|
-
|
30
|
-
# HTTP method
|
31
|
-
def method
|
32
|
-
:delete
|
33
|
-
end
|
34
|
-
|
35
|
-
# Values of body parameters as a Hash
|
36
|
-
def body_parameters
|
37
|
-
p = Hash.new
|
38
|
-
p
|
39
|
-
end
|
40
|
-
|
41
|
-
# Values of query parameters as a Hash.
|
42
|
-
# name of parameter => value of the parameter
|
43
|
-
def query_parameters
|
44
|
-
params = {}
|
45
|
-
params['itemType'] = @item_type
|
46
|
-
params['itemId'] = @item_id
|
47
|
-
params
|
48
|
-
end
|
49
|
-
|
50
|
-
# Relative path to the endpoint
|
51
|
-
def path
|
52
|
-
"/{databaseId}/groups/#{@group_id}/items/"
|
53
|
-
end
|
54
|
-
end
|
55
|
-
end
|