Skip to content

feat: Updated OpenAPI spec #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Apr 23, 2026
Merged

feat: Updated OpenAPI spec #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions ...ecombee/Generated/Recombee.IRecommendationsClient.CreateByDatabaseIdRecommsComposite.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ public partial interface IRecommendationsClient
{
/// <summary>
/// Composite Recommendation<br/>
/// 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.<br/>
/// Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations)) and a list of related recommendations in a single response.<br/>
/// It is ideal for use cases such as personalized homepage sections (*Articles from &lt;category&gt;*), *Because You Watched &lt;movie&gt;*, or *Artists Related to Your Favorite Artist &lt;artist&gt;*.<br/>
/// See detailed **examples and configuration guidance** in the [Composite Scenarios documentation](https://docs.recombee.com/scenarios#composite-recommendations).<br/>
/// **Structure**<br/>
Expand Down Expand Up @@ -38,7 +38,7 @@ public partial interface IRecommendationsClient
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// Composite Recommendation<br/>
/// 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.<br/>
/// Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations)) and a list of related recommendations in a single response.<br/>
/// It is ideal for use cases such as personalized homepage sections (*Articles from &lt;category&gt;*), *Because You Watched &lt;movie&gt;*, or *Artists Related to Your Favorite Artist &lt;artist&gt;*.<br/>
/// See detailed **examples and configuration guidance** in the [Composite Scenarios documentation](https://docs.recombee.com/scenarios#composite-recommendations).<br/>
/// **Structure**<br/>
Expand Down Expand Up @@ -76,6 +76,9 @@ public partial interface IRecommendationsClient
/// <param name="segmentId">
/// ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
/// </param>
/// <param name="searchQuery">
/// Search query provided by the user. It is used for the full-text search. Only applicable if the *scenario* corresponds to a search scenario.
/// </param>
/// <param name="cascadeCreate">
/// If the entity for the source recommendation does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that entity, as the entity will be already known to the system.
/// </param>
Expand All @@ -99,6 +102,7 @@ public partial interface IRecommendationsClient
string? userId = default,
global::Recombee.Logic? logic = default,
string? segmentId = default,
string? searchQuery = default,
bool? cascadeCreate = default,
object? sourceSettings = default,
object? resultSettings = default,
Expand Down
65 changes: 65 additions & 0 deletions .../Recombee.IRecommendationsClient.CreateByDatabaseIdRecommsNextItemSegmentsByRecommId.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
#nullable enable

namespace Recombee
{
public partial interface IRecommendationsClient
{
/// <summary>
/// Recommend Next Item Segments<br/>
/// Returns [Item Segments](https://docs.recombee.com/segmentations) to be shown as the next recommendations when a user scrolls (e.g., within a carousel or feed of Item Segments such as brands, artists, topics, or categories).<br/>
/// The request requires the `recommId` of a base recommendation request and the number of Segments to return (`count`).<br/>
/// The base request can be one of:<br/>
/// - [Recommend Item Segments to Item](https://docs.recombee.com/api#recommend-item-segments-to-item)<br/>
/// - [Recommend Item Segments to User](https://docs.recombee.com/api#recommend-item-segments-to-user)<br/>
/// - [Recommend Item Segments to Item Segment](https://docs.recombee.com/api#recommend-item-segments-to-item-segment)<br/>
/// - [Search Item Segments](https://docs.recombee.com/api#search-item-segments)<br/>
/// All other parameters are inherited from the base request associated with the provided `recommId`.<br/>
/// This endpoint can be called multiple times for a single `recommId`. Each call returns different Item Segments that have not been recommended in previous calls.<br/>
/// The number of calls made so far is returned in the `numberNextRecommsCalls` field.<br/>
/// Requests can be made up to 30 minutes after the base request or the most recent Recommend Next Item Segments call.<br/>
/// For billing purposes, each call to this endpoint is counted as a separate recommendation request.
/// </summary>
/// <param name="databaseId"></param>
/// <param name="recommId"></param>
/// <param name="request"></param>
/// <param name="requestOptions">Per-request overrides such as headers, query parameters, timeout, retries, and response buffering.</param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::Recombee.ApiException"></exception>
global::System.Threading.Tasks.Task<global::Recombee.RecommendationResponse> CreateByDatabaseIdRecommsNextItemSegmentsByRecommIdAsync(
string databaseId,
string recommId,

global::Recombee.RecommendNextItemSegmentsParameters request,
global::Recombee.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// Recommend Next Item Segments<br/>
/// Returns [Item Segments](https://docs.recombee.com/segmentations) to be shown as the next recommendations when a user scrolls (e.g., within a carousel or feed of Item Segments such as brands, artists, topics, or categories).<br/>
/// The request requires the `recommId` of a base recommendation request and the number of Segments to return (`count`).<br/>
/// The base request can be one of:<br/>
/// - [Recommend Item Segments to Item](https://docs.recombee.com/api#recommend-item-segments-to-item)<br/>
/// - [Recommend Item Segments to User](https://docs.recombee.com/api#recommend-item-segments-to-user)<br/>
/// - [Recommend Item Segments to Item Segment](https://docs.recombee.com/api#recommend-item-segments-to-item-segment)<br/>
/// - [Search Item Segments](https://docs.recombee.com/api#search-item-segments)<br/>
/// All other parameters are inherited from the base request associated with the provided `recommId`.<br/>
/// This endpoint can be called multiple times for a single `recommId`. Each call returns different Item Segments that have not been recommended in previous calls.<br/>
/// The number of calls made so far is returned in the `numberNextRecommsCalls` field.<br/>
/// Requests can be made up to 30 minutes after the base request or the most recent Recommend Next Item Segments call.<br/>
/// For billing purposes, each call to this endpoint is counted as a separate recommendation request.
/// </summary>
/// <param name="databaseId"></param>
/// <param name="recommId"></param>
/// <param name="count">
/// Number of item segments to be recommended
/// </param>
/// <param name="requestOptions">Per-request overrides such as headers, query parameters, timeout, retries, and response buffering.</param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
global::System.Threading.Tasks.Task<global::Recombee.RecommendationResponse> CreateByDatabaseIdRecommsNextItemSegmentsByRecommIdAsync(
string databaseId,
string recommId,
int count,
global::Recombee.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
1 change: 1 addition & 0 deletions src/libs/Recombee/Generated/Recombee.JsonSerializerContext.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ namespace Recombee
[global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Recombee.SearchItemsParameters))]
[global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Recombee.SearchItemSegmentsParameters))]
[global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Recombee.RecommendNextItemsParameters))]
[global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Recombee.RecommendNextItemSegmentsParameters))]
[global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Recombee.CreatePropertyBasedSegmentationParameters))]
[global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Recombee.UpdatePropertyBasedSegmentationParameters))]
[global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Recombee.CreateAutoReQLSegmentationParameters))]
Expand Down
84 changes: 44 additions & 40 deletions src/libs/Recombee/Generated/Recombee.JsonSerializerContextTypes.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,163 +196,167 @@ public sealed partial class JsonSerializerContextTypes
/// <summary>
///
/// </summary>
public global::Recombee.CreatePropertyBasedSegmentationParameters? Type42 { get; set; }
public global::Recombee.RecommendNextItemSegmentsParameters? Type42 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.UpdatePropertyBasedSegmentationParameters? Type43 { get; set; }
public global::Recombee.CreatePropertyBasedSegmentationParameters? Type43 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.CreateAutoReQLSegmentationParameters? Type44 { get; set; }
public global::Recombee.UpdatePropertyBasedSegmentationParameters? Type44 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.UpdateAutoReQLSegmentationParameters? Type45 { get; set; }
public global::Recombee.CreateAutoReQLSegmentationParameters? Type45 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.CreateManualReQLSegmentationParameters? Type46 { get; set; }
public global::Recombee.UpdateAutoReQLSegmentationParameters? Type46 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.UpdateManualReQLSegmentationParameters? Type47 { get; set; }
public global::Recombee.CreateManualReQLSegmentationParameters? Type47 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.ManualReQLSegmentParameters? Type48 { get; set; }
public global::Recombee.UpdateManualReQLSegmentationParameters? Type48 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.SearchResponse? Type49 { get; set; }
public global::Recombee.ManualReQLSegmentParameters? Type49 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.Recommendation>? Type50 { get; set; }
public global::Recombee.SearchResponse? Type50 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.Recommendation? Type51 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.Recommendation>? Type51 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.RecommendationResponse? Type52 { get; set; }
public global::Recombee.Recommendation? Type52 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.CompositeRecommendationResponse? Type53 { get; set; }
public global::Recombee.RecommendationResponse? Type53 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.Batch? Type54 { get; set; }
public global::Recombee.CompositeRecommendationResponse? Type54 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<object>? Type55 { get; set; }
public global::Recombee.Batch? Type55 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.Item? Type56 { get; set; }
public global::System.Collections.Generic.IList<object>? Type56 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.User? Type57 { get; set; }
public global::Recombee.Item? Type57 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.Series? Type58 { get; set; }
public global::Recombee.User? Type58 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.Group? Type59 { get; set; }
public global::Recombee.Series? Type59 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.SearchSynonymParams? Type60 { get; set; }
public global::Recombee.Group? Type60 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.SearchSynonym? Type61 { get; set; }
public global::Recombee.SearchSynonymParams? Type61 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.ListSearchSynonymsResponse? Type62 { get; set; }
public global::Recombee.SearchSynonym? Type62 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.SearchSynonym>? Type63 { get; set; }
public global::Recombee.ListSearchSynonymsResponse? Type63 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.Scenario? Type64 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.SearchSynonym>? Type64 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.Segmentation? Type65 { get; set; }
public global::Recombee.Scenario? Type65 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.ListSegmentationsResponse? Type66 { get; set; }
public global::Recombee.Segmentation? Type66 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.Segmentation>? Type67 { get; set; }
public global::Recombee.ListSegmentationsResponse? Type67 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.PutItemsPropertiesType? Type68 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.Segmentation>? Type68 { get; set; }
/// <summary>
///
/// </summary>
public global::Recombee.PutUsersPropertiesType? Type69 { get; set; }
public global::Recombee.PutItemsPropertiesType? Type69 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.Item>? Type70 { get; set; }
public global::Recombee.PutUsersPropertiesType? Type70 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.PropertyInfo>? Type71 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.Item>? Type71 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.Series>? Type72 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.PropertyInfo>? Type72 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.SeriesItem>? Type73 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.Series>? Type73 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.User>? Type74 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.SeriesItem>? Type74 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.DetailView>? Type75 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.User>? Type75 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.Purchase>? Type76 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.DetailView>? Type76 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.Rating>? Type77 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.Purchase>? Type77 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.CartAddition>? Type78 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.Rating>? Type78 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.Bookmark>? Type79 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.CartAddition>? Type79 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.ViewPortion>? Type80 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.Bookmark>? Type80 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.Scenario>? Type81 { get; set; }
public global::System.Collections.Generic.IList<global::Recombee.ViewPortion>? Type81 { get; set; }
/// <summary>
///
/// </summary>
public global::System.Collections.Generic.IList<global::Recombee.Scenario>? Type82 { get; set; }

/// <summary>
///
Expand Down
Loading