diff --git a/src/libs/Recombee/Generated/Recombee.IItemPropertiesClient.g.cs b/src/libs/Recombee/Generated/Recombee.IItemPropertiesClient.g.cs
index f565b9b..f82fb90 100644
--- a/src/libs/Recombee/Generated/Recombee.IItemPropertiesClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.IItemPropertiesClient.g.cs
@@ -32,12 +32,12 @@ public partial interface IItemPropertiesClient : global::System.IDisposable
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.IItemsClient.g.cs b/src/libs/Recombee/Generated/Recombee.IItemsClient.g.cs
index 7ee3bba..0dbb0a1 100644
--- a/src/libs/Recombee/Generated/Recombee.IItemsClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.IItemsClient.g.cs
@@ -32,12 +32,12 @@ public partial interface IItemsClient : global::System.IDisposable
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.IMiscellaneousClient.g.cs b/src/libs/Recombee/Generated/Recombee.IMiscellaneousClient.g.cs
index 0d93514..982f72a 100644
--- a/src/libs/Recombee/Generated/Recombee.IMiscellaneousClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.IMiscellaneousClient.g.cs
@@ -32,12 +32,12 @@ public partial interface IMiscellaneousClient : global::System.IDisposable
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.IRecombeeClient.g.cs b/src/libs/Recombee/Generated/Recombee.IRecombeeClient.g.cs
index 2d4f4fb..0793dc7 100644
--- a/src/libs/Recombee/Generated/Recombee.IRecombeeClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.IRecombeeClient.g.cs
@@ -35,12 +35,12 @@ public partial interface IRecombeeClient : global::System.IDisposable
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.IRecommendationsClient.g.cs b/src/libs/Recombee/Generated/Recombee.IRecommendationsClient.g.cs
index 522f772..d49044e 100644
--- a/src/libs/Recombee/Generated/Recombee.IRecommendationsClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.IRecommendationsClient.g.cs
@@ -32,12 +32,12 @@ public partial interface IRecommendationsClient : global::System.IDisposable
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.ISearchClient.g.cs b/src/libs/Recombee/Generated/Recombee.ISearchClient.g.cs
index d5ade3c..e4a2e7f 100644
--- a/src/libs/Recombee/Generated/Recombee.ISearchClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.ISearchClient.g.cs
@@ -32,12 +32,12 @@ public partial interface ISearchClient : global::System.IDisposable
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.ISegmentationsDefinitionClient.g.cs b/src/libs/Recombee/Generated/Recombee.ISegmentationsDefinitionClient.g.cs
index 83a3426..b8bc3aa 100644
--- a/src/libs/Recombee/Generated/Recombee.ISegmentationsDefinitionClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.ISegmentationsDefinitionClient.g.cs
@@ -32,12 +32,12 @@ public partial interface ISegmentationsDefinitionClient : global::System.IDispos
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.ISeriesClient.g.cs b/src/libs/Recombee/Generated/Recombee.ISeriesClient.g.cs
index 08c778c..173f713 100644
--- a/src/libs/Recombee/Generated/Recombee.ISeriesClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.ISeriesClient.g.cs
@@ -32,12 +32,12 @@ public partial interface ISeriesClient : global::System.IDisposable
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.IUserItemInteractionsClient.g.cs b/src/libs/Recombee/Generated/Recombee.IUserItemInteractionsClient.g.cs
index 73a74a7..2867e9b 100644
--- a/src/libs/Recombee/Generated/Recombee.IUserItemInteractionsClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.IUserItemInteractionsClient.g.cs
@@ -32,12 +32,12 @@ public partial interface IUserItemInteractionsClient : global::System.IDisposabl
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.IUserPropertiesClient.g.cs b/src/libs/Recombee/Generated/Recombee.IUserPropertiesClient.g.cs
index 753fa62..4a9b65d 100644
--- a/src/libs/Recombee/Generated/Recombee.IUserPropertiesClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.IUserPropertiesClient.g.cs
@@ -32,12 +32,12 @@ public partial interface IUserPropertiesClient : global::System.IDisposable
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.IUsersClient.g.cs b/src/libs/Recombee/Generated/Recombee.IUsersClient.g.cs
index 78e6e12..643e2fe 100644
--- a/src/libs/Recombee/Generated/Recombee.IUsersClient.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.IUsersClient.g.cs
@@ -32,12 +32,12 @@ public partial interface IUsersClient : global::System.IDisposable
/// ensuring is populated.
///
public bool ReadResponseAsString { get; set; }
-
///
/// Client-wide request defaults such as headers, query parameters, retries, and timeout.
///
public global::Recombee.AutoSDKClientOptions Options { get; }
+
///
///
///
diff --git a/src/libs/Recombee/Generated/Recombee.OptionsSupport.g.cs b/src/libs/Recombee/Generated/Recombee.OptionsSupport.g.cs
index c56c70a..d3480c0 100644
--- a/src/libs/Recombee/Generated/Recombee.OptionsSupport.g.cs
+++ b/src/libs/Recombee/Generated/Recombee.OptionsSupport.g.cs
@@ -106,6 +106,7 @@ public sealed class AutoSDKRetryOptions
public global::System.TimeSpan? Delay { get; set; }
}
+
///
/// Runtime hook interface for generated SDK lifecycle events.
///
@@ -236,6 +237,7 @@ public sealed class AutoSDKHookContext
public global::System.Threading.CancellationToken CancellationToken { get; set; }
}
+
internal static class AutoSDKRequestOptionsSupport
{
internal static global::Recombee.AutoSDKHookContext CreateHookContext(
diff --git a/src/libs/Recombee/Generated/autosdk.generated-examples.json b/src/libs/Recombee/Generated/autosdk.generated-examples.json
new file mode 100644
index 0000000..da92e53
--- /dev/null
+++ b/src/libs/Recombee/Generated/autosdk.generated-examples.json
@@ -0,0 +1,466 @@
+{
+ "Examples": [
+ {
+ "Order": 1,
+ "Title": "Update More Items",
+ "Slug": "update-more-items",
+ "Description": "Updates (some) property values of all the items that pass the filter.\n\nExample: *Setting all the items that are older than a week as unavailable*\n\n \u0060\u0060\u0060json\n {\n \u0022filter\u0022: \u0022\u0027releaseDate\u0027 \u003C now() - 7*24*3600\u0022,\n \u0022changes\u0022: {\u0022available\u0022: false}\n }\n \u0060\u0060\u0060",
+ "Language": "http",
+ "Code": "### Update More Items\nPOST {{host}}/{{databaseId}}/more-items/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022filter\u0022: \u0022string\u0022,\n \u0022changes\u0022: {}\n}\n\n## Responses\n# 200\n# Description: Successful operation. Returns IDs of updated items and their count.\n# Content-Type: application/json\n# 400\n# Description: Invalid filter, property name does not match \u0027\u0027^[a-zA-Z0-9_\\-:]\u002B$\u0027\u0027, value does not match the property type.\n\n# 404\n# Description: Property of the given name is not present in the database.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdMoreItems",
+ "Setup": null
+ },
+ {
+ "Order": 2,
+ "Title": "Get Item Values",
+ "Slug": "get-item-values",
+ "Description": "Gets all the current property values of the given item.",
+ "Language": "http",
+ "Code": "### Get Item Values\nGET {{host}}/{{databaseId}}/items/{{itemId}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The *itemId* does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$\n# 404\n# Description: Item of the given *itemId* is not present in the catalog. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsByItemId",
+ "Setup": null
+ },
+ {
+ "Order": 3,
+ "Title": "Get Item Property Info",
+ "Slug": "get-item-property-info",
+ "Description": "Gets information about specified item property.",
+ "Language": "http",
+ "Code": "### Get Item Property Info\nGET {{host}}/{{databaseId}}/items/properties/{{propertyName}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: Property name does not match ^[a-zA-Z0-9_\\-:]\u002B$.\n# 404\n# Description: Property of the given name is not present in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsPropertiesByPropertyName",
+ "Setup": null
+ },
+ {
+ "Order": 4,
+ "Title": "List Item Properties",
+ "Slug": "list-item-properties",
+ "Description": "Gets the list of all the item properties in your database.",
+ "Language": "http",
+ "Code": "### List Item Properties\nGET {{host}}/{{databaseId}}/items/properties/list/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 404\n# Description: Invalid URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsPropertiesList",
+ "Setup": null
+ },
+ {
+ "Order": 5,
+ "Title": "Delete More Items",
+ "Slug": "delete-more-items",
+ "Description": "Deletes all the items that pass the filter.\n\nIf an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.",
+ "Language": "http",
+ "Code": "### Delete More Items\nDELETE {{host}}/{{databaseId}}/more-items/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022filter\u0022: \u0022string\u0022\n}\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: Invalid filter.",
+ "Format": "http",
+ "OperationId": "deleteByDatabaseIdMoreItems",
+ "Setup": null
+ },
+ {
+ "Order": 6,
+ "Title": "List Items",
+ "Slug": "list-items",
+ "Description": "Gets a list of IDs of items currently present in the catalog.",
+ "Language": "http",
+ "Code": "### List Items\nGET {{host}}/{{databaseId}}/items/list/?filter={{filter}}\u0026count={{count}}\u0026offset={{offset}}\u0026returnProperties={{returnProperties}}\u0026includedProperties={{includedProperties}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 404\n# Description: If present, \u0060filter\u0060 contains a non-existing item property.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsList",
+ "Setup": null
+ },
+ {
+ "Order": 7,
+ "Title": "Batch",
+ "Slug": "batch",
+ "Description": "Batch processing allows you to submit arbitrary sequence of requests within a single HTTPS request.\n\nAny type of request from the above documentation may be used in the Batch, and the Batch may combine different types of requests arbitrarily as well.\n\nUsing Batch requests is beneficial for example, when synchronizing the catalog of items or uploading historical interaction data, as sending the data in Batch is considerably faster than sending the individual requests (thanks to optimizations and reducing network and HTTPS overhead).",
+ "Language": "http",
+ "Code": "### Batch\nPOST {{host}}/{{databaseId}}/batch/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022requests\u0022: [\n {}\n ],\n \u0022distinctRecomms\u0022: true\n}\n\n## Responses\n# 200\n# Description: Successful operation. There is an array with responses. The order of the responses in the array follows the order of the sent requests.\n# Content-Type: application/json\n# 400\n# Description: Many possibilities, see the error description in the result JSON. Examples: invalid or missing Content-type (not \u0060application/json\u0060), request body is not a valid JSON, request JSON does not have the prescribed structure.\n\n# 404\n# Description: There is at least one request in the batch with an invalid (non-existing) URL. In such a case, the batch as a whole **is not executed** and you\u0027ll get HTTP 404, because the batch is apriori erroneous.\n# 413\n# Description: Too large batch (containing more than 10,000 requests in case of a server side request).",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdBatch",
+ "Setup": null
+ },
+ {
+ "Order": 8,
+ "Title": "List Scenarios",
+ "Slug": "list-scenarios",
+ "Description": "Get all [Scenarios](https://docs.recombee.com/scenarios) of the given database.",
+ "Language": "http",
+ "Code": "### List Scenarios\nGET {{host}}/{{databaseId}}/scenarios/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdScenarios",
+ "Setup": null
+ },
+ {
+ "Order": 9,
+ "Title": "Composite Recommendation",
+ "Slug": "composite-recommendation",
+ "Description": "Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations.html)) and a list of related recommendations in a single response.\n\nIt is ideal for use cases such as personalized homepage sections (*Articles from \u003Ccategory\u003E*), *Because You Watched \u003Cmovie\u003E*, or *Artists Related to Your Favorite Artist \u003Cartist\u003E*.\n\nSee detailed **examples and configuration guidance** in the [Composite Scenarios documentation](https://docs.recombee.com/scenarios#composite-recommendations).\n\n**Structure**\n\nThe endpoint operates in two stages:\n1. Recommends the *source* (e.g., an Item Segment or item) to the user.\n2. Recommends *results* (items or Item Segments) related to that *source*.\n\nFor example, *Articles from \u003Ccategory\u003E* can be decomposed into:\n - [Recommend Item Segments To User](https://docs.recombee.com/api#recommend-item-segments-to-user) to find the category.\n - [Recommend Items To Item Segment](https://docs.recombee.com/api#recommend-items-to-item-segment) to recommend articles from that category.\n\nSince the first step uses [Recommend Item Segments To User](https://docs.recombee.com/api#recommend-items-to-user), you must include the \u0060userId\u0060 parameter in the *Composite Recommendation* request.\n\nEach *Composite Recommendation* counts as a single recommendation API request for billing.\n\n**Stage-specific Parameters**\n\nAdditional parameters can be supplied via [sourceSettings](https://docs.recombee.com/api#composite-recommendation-param-sourceSettings) and [resultSettings](https://docs.recombee.com/api#composite-recommendation-param-resultSettings).\nIn the example above:\n - \u0060sourceSettings\u0060 may include any parameter valid for [Recommend Item Segments To User](https://docs.recombee.com/api#recommend-items-to-user) (e.g., \u0060filter\u0060, \u0060booster\u0060).\n - \u0060resultSettings\u0060 may include any parameter valid for [Recommend Items To Item Segment](https://docs.recombee.com/api#recommend-items-to-item-segment).\n\nSee [this example](https://docs.recombee.com/api#composite-recommendation-example-setting-parameters-for-individual-stages) for more details.",
+ "Language": "http",
+ "Code": "### Composite Recommendation\nPOST {{host}}/{{databaseId}}/recomms/composite/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022count\u0022: 0,\n \u0022itemId\u0022: \u0022string\u0022,\n \u0022userId\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022segmentId\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022sourceSettings\u0022: {},\n \u0022resultSettings\u0022: {},\n \u0022expertSettings\u0022: {}\n}\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: Count is not a positive integer, provided scenario not found.\n# 404\n# Description: contextSegmentId not found in the context segmentation, userId not found in the database and cascadeCreate is false, itemId not found in the database and cascadeCreate is false.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsComposite",
+ "Setup": null
+ },
+ {
+ "Order": 10,
+ "Title": "Recommend Item Segments to Item Segment",
+ "Slug": "recommend-item-segments-to-item-segment",
+ "Description": "Recommends Segments from a result [Segmentation](https://docs.recombee.com/segmentations) that are the most relevant to a particular Segment from a context Segmentation.\n\nBased on the used Segmentations, this endpoint can be used for example for:\n\n - Recommending the related brands to particular brand\n - Recommending the related brands to particular category\n - Recommending the related artists to a particular genre (assuming songs are the Items)\n\nYou need to set the used context and result Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.\n\nThe returned segments are sorted by relevance (first segment being the most relevant).\n\nIt is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.",
+ "Language": "http",
+ "Code": "### Recommend Item Segments to Item Segment\nPOST {{host}}/{{databaseId}}/recomms/item-segments/item-segments/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022contextSegmentId\u0022: \u0022string\u0022,\n \u0022targetUserId\u0022: \u0022string\u0022,\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true,\n \u0022reqlExpressions\u0022: {}\n}\n\n## Responses\n# 200\n# Description: successful operation\n# Content-Type: application/json\n# 400\n# Description: count is not a positive integer.\n# 404\n# Description: contextSegmentId not found in the context segmentation",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsItemSegmentsItemSegments",
+ "Setup": null
+ },
+ {
+ "Order": 11,
+ "Title": "Recommend Items to Item Segment",
+ "Slug": "recommend-items-to-item-segment",
+ "Description": "Recommends Items that are the most relevant to a particular Segment from a context [Segmentation](https://docs.recombee.com/segmentations).\n\nBased on the used Segmentation, this endpoint can be used for example for:\n\n- Recommending articles related to a particular topic\n- Recommending songs belonging to a particular genre\n- Recommending products produced by a particular brand\n\nYou need to set the used context Segmentation in the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.\n\nThe returned items are sorted by relevance (the first item being the most relevant).\n\nIt is also possible to use the POST HTTP method (for example, in the case of a very long ReQL filter) \u2014 query parameters then become body parameters.",
+ "Language": "http",
+ "Code": "### Recommend Items to Item Segment\nPOST {{host}}/{{databaseId}}/recomms/item-segments/items/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022contextSegmentId\u0022: \u0022string\u0022,\n \u0022targetUserId\u0022: \u0022string\u0022,\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022returnProperties\u0022: true,\n \u0022includedProperties\u0022: [\n \u0022string\u0022\n ],\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022reqlExpressions\u0022: {},\n \u0022minRelevance\u0022: \u0022low\u0022,\n \u0022rotationRate\u0022: 0,\n \u0022rotationTime\u0022: 0,\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true\n}\n\n## Responses\n# 200\n# Description: successful operation\n# Content-Type: application/json\n# 400\n# Description: count is not a positive integer.\n# 404\n# Description: contextSegmentId not found in the context segmentation",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsItemSegmentsItems",
+ "Setup": null
+ },
+ {
+ "Order": 12,
+ "Title": "Recommend Item Segments to Item",
+ "Slug": "recommend-item-segments-to-item",
+ "Description": "Recommends Segments from a [Segmentation](https://docs.recombee.com/segmentations) that are the most relevant to a particular item.\n\nBased on the used Segmentation, this endpoint can be used for example for:\n\n - Recommending the related categories\n - Recommending the related genres\n - Recommending the related brands\n - Recommending the related artists\n\nYou need to set the used Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.\n\nThe returned segments are sorted by relevance (first segment being the most relevant).\n\nIt is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.",
+ "Language": "http",
+ "Code": "### Recommend Item Segments to Item\nPOST {{host}}/{{databaseId}}/recomms/items/{{itemId}}/item-segments/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022targetUserId\u0022: \u0022string\u0022,\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true,\n \u0022reqlExpressions\u0022: {}\n}\n\n## Responses\n# 200\n# Description: successful operation\n# Content-Type: application/json\n# 400\n# Description: Used Segmentation not configured for the scenario. itemId does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$, count is not a positive integer.\n# 404\n# Description: itemId not found in the database and cascadeCreate is false",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsItemsByItemIdItemSegments",
+ "Setup": null
+ },
+ {
+ "Order": 13,
+ "Title": "Recommend Items to Item",
+ "Slug": "recommend-items-to-item",
+ "Description": "Recommends a set of items that are somehow related to one given item, *X*. A typical scenario is when the user *A* is viewing *X*. Then you may display items to the user that he might also be interested in. Recommend items to item request gives you Top-N such items, optionally taking the target user *A* into account.\n\nThe returned items are sorted by relevance (the first item being the most relevant).\n\nBesides the recommended items, also a unique \u0060recommId\u0060 is returned in the response. It can be used to:\n\n- Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui#reported-metrics).\n- Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api#recommend-next-items).\n\nIt is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.",
+ "Language": "http",
+ "Code": "### Recommend Items to Item\nPOST {{host}}/{{databaseId}}/recomms/items/{{itemId}}/items/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022targetUserId\u0022: \u0022string\u0022,\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022returnProperties\u0022: true,\n \u0022includedProperties\u0022: [\n \u0022string\u0022\n ],\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022reqlExpressions\u0022: {},\n \u0022userImpact\u0022: 0,\n \u0022diversity\u0022: 0,\n \u0022minRelevance\u0022: \u0022low\u0022,\n \u0022rotationRate\u0022: 0,\n \u0022rotationTime\u0022: 0,\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true\n}\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: itemId does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$, count is not a positive integer, filter or booster is not valid [ReQL](https://docs.recombee.com/reql) expressions, filter expression does not return boolean, booster does not return double or integer.\n# 404\n# Description: itemId not found in the database and cascadeCreate is false. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsItemsByItemIdItems",
+ "Setup": null
+ },
+ {
+ "Order": 14,
+ "Title": "Recommend Users to Item",
+ "Slug": "recommend-users-to-item",
+ "Description": "Recommends users that are likely to be interested in the given item.\n\nIt is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.\n\nThe returned users are sorted by predicted interest in the item (the first user being the most interested).",
+ "Language": "http",
+ "Code": "### Recommend Users to Item\nPOST {{host}}/{{databaseId}}/recomms/items/{{itemId}}/users/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022returnProperties\u0022: true,\n \u0022includedProperties\u0022: [\n \u0022string\u0022\n ],\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022reqlExpressions\u0022: {},\n \u0022diversity\u0022: 0,\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true\n}\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: itemId does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$, count is not a positive integer, filter or booster is not valid [ReQL](https://docs.recombee.com/reql) expressions, filter expression does not return boolean, booster does not return double or integer.\n# 404\n# Description: itemId not found in the database and cascadeCreate is false. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsItemsByItemIdUsers",
+ "Setup": null
+ },
+ {
+ "Order": 15,
+ "Title": "Recommend Next Items",
+ "Slug": "recommend-next-items",
+ "Description": "Returns items that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (*infinite scroll*) or goes to the next page.\n\nIt accepts \u0060recommId\u0060 of a base recommendation request (e.g., request from the first page) and the number of items that shall be returned (\u0060count\u0060).\nThe base request can be one of:\n - [Recommend Items to Item](https://docs.recombee.com/api#recommend-items-to-item)\n - [Recommend Items to User](https://docs.recombee.com/api#recommend-items-to-user)\n - [Recommend Items to Item Segment](https://docs.recombee.com/api#recommend-items-to-item-segment)\n - [Search Items](https://docs.recombee.com/api#search-items)\n\nAll the other parameters are inherited from the base request.\n\n*Recommend next items* can be called many times for a single \u0060recommId\u0060 and each call returns different (previously not recommended) items.\nThe number of *Recommend next items* calls performed so far is returned in the \u0060numberNextRecommsCalls\u0060 field.\n\n*Recommend next items* can be requested up to 30 minutes after the base request or a previous *Recommend next items* call.\n\nFor billing purposes, each call to *Recommend next items* is counted as a separate recommendation request.",
+ "Language": "http",
+ "Code": "### Recommend Next Items\nPOST {{host}}/{{databaseId}}/recomms/next/items/{{recommId}}\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022count\u0022: 0\n}\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: Parameter \u0060count\u0060 is not given or is not a positive integer. Parameter \u0060recommId\u0060 is not an UUID.\n# 404\n# Description: Base request with the given \u0060recommId\u0060 does not exist or has expired.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsNextItemsByRecommId",
+ "Setup": null
+ },
+ {
+ "Order": 16,
+ "Title": "Recommend Item Segments to User",
+ "Slug": "recommend-item-segments-to-user",
+ "Description": "Recommends the top Segments from a [Segmentation](https://docs.recombee.com/segmentations) for a particular user, based on the user\u0027s past interactions.\n\nBased on the used Segmentation, this endpoint can be used for example for:\n\n - Recommending the top categories for the user\n - Recommending the top genres for the user\n - Recommending the top brands for the user\n - Recommending the top artists for the user\n\nYou need to set the used Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.\n\nThe returned segments are sorted by relevance (first segment being the most relevant).\n\nIt is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.",
+ "Language": "http",
+ "Code": "### Recommend Item Segments to User\nPOST {{host}}/{{databaseId}}/recomms/users/{{userId}}/item-segments/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true,\n \u0022reqlExpressions\u0022: {}\n}\n\n## Responses\n# 200\n# Description: successful operation\n# Content-Type: application/json\n# 400\n# Description: Used Segmentation not configured for the scenario. userId does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$, count is not a positive integer.\n# 404\n# Description: userId not found in the database and cascadeCreate is false",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsUsersByUserIdItemSegments",
+ "Setup": null
+ },
+ {
+ "Order": 17,
+ "Title": "Recommend Items to User",
+ "Slug": "recommend-items-to-user",
+ "Description": "Based on the user\u0027s past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for the given user.\n\nThe most typical use cases are recommendations on the homepage, in some \u0022Picked just for you\u0022 section, or in email.\n\nThe returned items are sorted by relevance (the first item being the most relevant).\n\nBesides the recommended items, also a unique \u0060recommId\u0060 is returned in the response. It can be used to:\n\n- Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui#reported-metrics).\n- Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api#recommend-next-items).\n\nIt is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.",
+ "Language": "http",
+ "Code": "### Recommend Items to User\nPOST {{host}}/{{databaseId}}/recomms/users/{{userId}}/items/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022returnProperties\u0022: true,\n \u0022includedProperties\u0022: [\n \u0022string\u0022\n ],\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022reqlExpressions\u0022: {},\n \u0022diversity\u0022: 0,\n \u0022minRelevance\u0022: \u0022low\u0022,\n \u0022rotationRate\u0022: 0,\n \u0022rotationTime\u0022: 0,\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true\n}\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: userId does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$, count is not a positive integer, filter or booster is not valid [ReQL](https://docs.recombee.com/reql) expressions, filter expression does not return boolean, booster does not return double or integer.\n# 404\n# Description: userId not found in the database and cascadeCreate is false. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsUsersByUserIdItems",
+ "Setup": null
+ },
+ {
+ "Order": 18,
+ "Title": "Recommend Users to User",
+ "Slug": "recommend-users-to-user",
+ "Description": "Gets users similar to the given user, based on the user\u0027s past interactions (purchases, ratings, etc.) and values of properties.\n\nIt is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.\n\nThe returned users are sorted by similarity (the first user being the most similar).",
+ "Language": "http",
+ "Code": "### Recommend Users to User\nPOST {{host}}/{{databaseId}}/recomms/users/{{userId}}/users/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022returnProperties\u0022: true,\n \u0022includedProperties\u0022: [\n \u0022string\u0022\n ],\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022reqlExpressions\u0022: {},\n \u0022diversity\u0022: 0,\n \u0022minRelevance\u0022: \u0022low\u0022,\n \u0022rotationRate\u0022: 0,\n \u0022rotationTime\u0022: 0,\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true\n}\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: userId does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$, count is not a positive integer, filter or booster is not valid [ReQL](https://docs.recombee.com/reql) expressions, filter expression does not return boolean, booster does not return double or integer.\n# 404\n# Description: userId not found in the database and cascadeCreate is false. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdRecommsUsersByUserIdUsers",
+ "Setup": null
+ },
+ {
+ "Order": 19,
+ "Title": "Search Item Segments",
+ "Slug": "search-item-segments",
+ "Description": "Full-text personalized search that returns Segments from a Segmentation. The results are based on the provided \u0060searchQuery\u0060 and also on the user\u0027s past interactions (purchases, ratings, etc.).\n\nBased on the used Segmentation, this endpoint can be used for example for:\n\n - Searching within categories or brands\n - Searching within genres or artists\n\nFor example if the user is searching for \u0022iPhone\u0022 this endpoint can return \u0022cell phones\u0022 category.\n\nYou need to set the used Segmentation the Admin UI in the Scenario settings prior to using this endpoint.\n\nThe returned segments are sorted by relevance (first segment being the most relevant).\n\nIt is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.",
+ "Language": "http",
+ "Code": "### Search Item Segments\nPOST {{host}}/{{databaseId}}/search/users/{{userId}}/item-segments/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022searchQuery\u0022: \u0022string\u0022,\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true,\n \u0022reqlExpressions\u0022: {}\n}\n\n## Responses\n# 200\n# Description: successful operation\n# Content-Type: application/json\n# 400\n# Description: userId does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$, count is not a positive integer, searchQuery is not provided, filter or booster is not valid [ReQL](https://docs.recombee.com/reql) expressions, filter expression does not return boolean, booster does not return double or integer.\n# 404\n# Description: userId not found in the database and cascadeCreate is false. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdSearchUsersByUserIdItemSegments",
+ "Setup": null
+ },
+ {
+ "Order": 20,
+ "Title": "Search Items",
+ "Slug": "search-items",
+ "Description": "Full-text personalized search. The results are based on the provided \u0060searchQuery\u0060 and also on the user\u0027s past interactions (purchases, ratings, etc.) with the items (items more suitable for the user are preferred in the results).\n\nAll the string and set item properties are indexed by the search engine.\n\nThis endpoint should be used in a search box on your website/app. It can be called multiple times as the user is typing the query in order to get the most viable suggestions based on the current state of the query, or once after submitting the whole query. \n\nThe returned items are sorted by relevance (the first item being the most relevant).\n\nBesides the recommended items, also a unique \u0060recommId\u0060 is returned in the response. It can be used to:\n\n- Let Recombee know that this search was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui#reported-metrics).\n- Get subsequent search results when the user scrolls down or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api#recommend-next-items).\n\nIt is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.",
+ "Language": "http",
+ "Code": "### Search Items\nPOST {{host}}/{{databaseId}}/search/users/{{userId}}/items/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022searchQuery\u0022: \u0022string\u0022,\n \u0022count\u0022: 0,\n \u0022scenario\u0022: \u0022string\u0022,\n \u0022cascadeCreate\u0022: true,\n \u0022returnProperties\u0022: true,\n \u0022includedProperties\u0022: [\n \u0022string\u0022\n ],\n \u0022filter\u0022: \u0022string\u0022,\n \u0022booster\u0022: \u0022string\u0022,\n \u0022logic\u0022: \u0022string\u0022,\n \u0022reqlExpressions\u0022: {},\n \u0022expertSettings\u0022: {},\n \u0022returnAbGroup\u0022: true\n}\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: userId does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$, count is not a positive integer, searchQuery is not provided, filter or booster are not valid [ReQL](https://docs.recombee.com/reql) expressions, filter expression does not return boolean, booster does not return double or integer.\n# 404\n# Description: userId not found in the database and cascadeCreate is false. If there is no additional info in the JSON response, you probably have an error in you URL.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdSearchUsersByUserIdItems",
+ "Setup": null
+ },
+ {
+ "Order": 21,
+ "Title": "Add Search Synonym",
+ "Slug": "add-search-synonym",
+ "Description": "Adds a new synonym for the [Search items](https://docs.recombee.com/api#search-items).\n\nWhen the \u0060term\u0060 is used in the search query, the \u0060synonym\u0060 is also used for the full-text search.\nUnless \u0060oneWay=true\u0060, it works also in the opposite way (\u0060synonym\u0060 -\u003E \u0060term\u0060).\n\nAn example of a synonym can be \u0060science fiction\u0060 for the term \u0060sci-fi\u0060.",
+ "Language": "http",
+ "Code": "### Add Search Synonym\nPOST {{host}}/{{databaseId}}/synonyms/items/\nAuthorization: Bearer {{token}}\nContent-Type: application/json\nAccept: application/json\n\n{\n \u0022term\u0022: \u0022string\u0022,\n \u0022synonym\u0022: \u0022string\u0022,\n \u0022oneWay\u0022: true\n}\n\n## Responses\n# 201\n# Description: Successful operation. Returns data about the added synonym (including \u0060id\u0060).\n# Content-Type: application/json\n# 400\n# Description: Missing a field, or a field has a wrong type.\n# 409\n# Description: \u0060synonym\u0060 and \u0060term\u0060 pair already exists in the database. In many cases, you may consider this code a success \u2013 it only tells you that nothing has been written to the database.",
+ "Format": "http",
+ "OperationId": "createByDatabaseIdSynonymsItems",
+ "Setup": null
+ },
+ {
+ "Order": 22,
+ "Title": "List Search Synonyms",
+ "Slug": "list-search-synonyms",
+ "Description": "Gives the list of synonyms defined in the database.",
+ "Language": "http",
+ "Code": "### List Search Synonyms\nGET {{host}}/{{databaseId}}/synonyms/items/?count={{count}}\u0026offset={{offset}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdSynonymsItems",
+ "Setup": null
+ },
+ {
+ "Order": 23,
+ "Title": "List Segmentations",
+ "Slug": "list-segmentations",
+ "Description": "Return all existing items Segmentations.",
+ "Language": "http",
+ "Code": "### List Segmentations\nGET {{host}}/{{databaseId}}/segmentations/list/?sourceType={{sourceType}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Content-Type: application/json",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdSegmentationsList",
+ "Setup": null
+ },
+ {
+ "Order": 24,
+ "Title": "Get Segmentation",
+ "Slug": "get-segmentation",
+ "Description": "Get existing Segmentation.",
+ "Language": "http",
+ "Code": "### Get Segmentation\nGET {{host}}/{{databaseId}}/segmentations/list/{{segmentationId}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Content-Type: application/json\n# 404\n# Description: Segmentation with given ID does not exist.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdSegmentationsListBySegmentationId",
+ "Setup": null
+ },
+ {
+ "Order": 25,
+ "Title": "List Series Items",
+ "Slug": "list-series-items",
+ "Description": "Lists all the items present in the given series, sorted according to their time index values.",
+ "Language": "http",
+ "Code": "### List Series Items\nGET {{host}}/{{databaseId}}/series/{{seriesId}}/items/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060seriesId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Series of the given \u0060seriesId\u0060 is not present in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdSeriesBySeriesIdItems",
+ "Setup": null
+ },
+ {
+ "Order": 26,
+ "Title": "List Series",
+ "Slug": "list-series",
+ "Description": "Gets the list of all the series currently present in the database.",
+ "Language": "http",
+ "Code": "### List Series\nGET {{host}}/{{databaseId}}/series/list/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 404\n# Description: Invalid URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdSeriesList",
+ "Setup": null
+ },
+ {
+ "Order": 27,
+ "Title": "List Item Bookmarks",
+ "Slug": "list-item-bookmarks",
+ "Description": "Lists all the ever-made bookmarks of the given item.",
+ "Language": "http",
+ "Code": "### List Item Bookmarks\nGET {{host}}/{{databaseId}}/items/{{itemId}}/bookmarks/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060itemId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060itemId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsByItemIdBookmarks",
+ "Setup": null
+ },
+ {
+ "Order": 28,
+ "Title": "List Item Cart Additions",
+ "Slug": "list-item-cart-additions",
+ "Description": "Lists all the ever-made cart additions of the given item.",
+ "Language": "http",
+ "Code": "### List Item Cart Additions\nGET {{host}}/{{databaseId}}/items/{{itemId}}/cartadditions/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060itemId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060itemId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsByItemIdCartadditions",
+ "Setup": null
+ },
+ {
+ "Order": 29,
+ "Title": "List Item Detail Views",
+ "Slug": "list-item-detail-views",
+ "Description": "Lists all the detail views of the given item ever made by different users.",
+ "Language": "http",
+ "Code": "### List Item Detail Views\nGET {{host}}/{{databaseId}}/items/{{itemId}}/detailviews/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060itemId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060itemId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsByItemIdDetailviews",
+ "Setup": null
+ },
+ {
+ "Order": 30,
+ "Title": "List Item Purchases",
+ "Slug": "list-item-purchases",
+ "Description": "Lists all the ever-made purchases of the given item.",
+ "Language": "http",
+ "Code": "### List Item Purchases\nGET {{host}}/{{databaseId}}/items/{{itemId}}/purchases/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060itemId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060itemId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsByItemIdPurchases",
+ "Setup": null
+ },
+ {
+ "Order": 31,
+ "Title": "List Item Ratings",
+ "Slug": "list-item-ratings",
+ "Description": "Lists all the ratings of an item ever submitted by different users.",
+ "Language": "http",
+ "Code": "### List Item Ratings\nGET {{host}}/{{databaseId}}/items/{{itemId}}/ratings/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060itemId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060itemId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsByItemIdRatings",
+ "Setup": null
+ },
+ {
+ "Order": 32,
+ "Title": "List Item View Portions",
+ "Slug": "list-item-view-portions",
+ "Description": "Lists all the view portions of an item ever submitted by different users.",
+ "Language": "http",
+ "Code": "### List Item View Portions\nGET {{host}}/{{databaseId}}/items/{{itemId}}/viewportions/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060itemId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060itemId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdItemsByItemIdViewportions",
+ "Setup": null
+ },
+ {
+ "Order": 33,
+ "Title": "List User Bookmarks",
+ "Slug": "list-user-bookmarks",
+ "Description": "Lists all the bookmarks ever made by the given user.",
+ "Language": "http",
+ "Code": "### List User Bookmarks\nGET {{host}}/{{databaseId}}/users/{{userId}}/bookmarks/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060userId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060userId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersByUserIdBookmarks",
+ "Setup": null
+ },
+ {
+ "Order": 34,
+ "Title": "List User Cart Additions",
+ "Slug": "list-user-cart-additions",
+ "Description": "Lists all the cart additions ever made by the given user.",
+ "Language": "http",
+ "Code": "### List User Cart Additions\nGET {{host}}/{{databaseId}}/users/{{userId}}/cartadditions/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060userId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060userId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersByUserIdCartadditions",
+ "Setup": null
+ },
+ {
+ "Order": 35,
+ "Title": "List User Detail Views",
+ "Slug": "list-user-detail-views",
+ "Description": "Lists all the detail views of different items ever made by the given user.",
+ "Language": "http",
+ "Code": "### List User Detail Views\nGET {{host}}/{{databaseId}}/users/{{userId}}/detailviews/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060userId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060userId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersByUserIdDetailviews",
+ "Setup": null
+ },
+ {
+ "Order": 36,
+ "Title": "List User Purchases",
+ "Slug": "list-user-purchases",
+ "Description": "Lists all the purchases ever made by the given user.",
+ "Language": "http",
+ "Code": "### List User Purchases\nGET {{host}}/{{databaseId}}/users/{{userId}}/purchases/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060userId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060userId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersByUserIdPurchases",
+ "Setup": null
+ },
+ {
+ "Order": 37,
+ "Title": "List User Ratings",
+ "Slug": "list-user-ratings",
+ "Description": "Lists all the ratings ever submitted by the given user.",
+ "Language": "http",
+ "Code": "### List User Ratings\nGET {{host}}/{{databaseId}}/users/{{userId}}/ratings/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060userId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060userId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersByUserIdRatings",
+ "Setup": null
+ },
+ {
+ "Order": 38,
+ "Title": "List User View Portions",
+ "Slug": "list-user-view-portions",
+ "Description": "Lists all the view portions ever submitted by the given user.",
+ "Language": "http",
+ "Code": "### List User View Portions\nGET {{host}}/{{databaseId}}/users/{{userId}}/viewportions/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The \u0060userId\u0060 does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$.\n# 404\n# Description: Given \u0060userId\u0060 not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersByUserIdViewportions",
+ "Setup": null
+ },
+ {
+ "Order": 39,
+ "Title": "Get User Values",
+ "Slug": "get-user-values",
+ "Description": "Gets all the current property values of the given user.",
+ "Language": "http",
+ "Code": "### Get User Values\nGET {{host}}/{{databaseId}}/users/{{userId}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: The *userId* does not match ^[a-zA-Z0-9_\\-:@\\.]\u002B$\n# 404\n# Description: User of the given *userId* is not present in the catalog. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersByUserId",
+ "Setup": null
+ },
+ {
+ "Order": 40,
+ "Title": "Get User Property Info",
+ "Slug": "get-user-property-info",
+ "Description": "Gets information about specified user property.",
+ "Language": "http",
+ "Code": "### Get User Property Info\nGET {{host}}/{{databaseId}}/users/properties/{{propertyName}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 400\n# Description: Property name does not match ^[a-zA-Z0-9_\\-:]\u002B$.\n# 404\n# Description: Property of the given name is not present in the database. If there is no additional info in the JSON response, you probably have an error in your URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersPropertiesByPropertyName",
+ "Setup": null
+ },
+ {
+ "Order": 41,
+ "Title": "List User Properties",
+ "Slug": "list-user-properties",
+ "Description": "Gets the list of all the user properties in your database.",
+ "Language": "http",
+ "Code": "### List User Properties\nGET {{host}}/{{databaseId}}/users/properties/list/\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 404\n# Description: Invalid URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersPropertiesList",
+ "Setup": null
+ },
+ {
+ "Order": 42,
+ "Title": "List Users",
+ "Slug": "list-users",
+ "Description": "Gets a list of IDs of users currently present in the catalog.",
+ "Language": "http",
+ "Code": "### List Users\nGET {{host}}/{{databaseId}}/users/list/?filter={{filter}}\u0026count={{count}}\u0026offset={{offset}}\u0026returnProperties={{returnProperties}}\u0026includedProperties={{includedProperties}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Successful operation.\n# Content-Type: application/json\n# 404\n# Description: Invalid URL.",
+ "Format": "http",
+ "OperationId": "getByDatabaseIdUsersList",
+ "Setup": null
+ }
+ ]
+}
\ No newline at end of file