Recombee API Client: Recombee.ApiClient.ApiRequests.Request Class Reference

Recombee API Client

Base class for all the requests More...

Inherited by Recombee.ApiClient.ApiRequests.AddBookmark, Recombee.ApiClient.ApiRequests.AddCartAddition, Recombee.ApiClient.ApiRequests.AddDetailView, Recombee.ApiClient.ApiRequests.AddGroup, Recombee.ApiClient.ApiRequests.AddItem, Recombee.ApiClient.ApiRequests.AddItemProperty, Recombee.ApiClient.ApiRequests.AddPurchase, Recombee.ApiClient.ApiRequests.AddRating, Recombee.ApiClient.ApiRequests.AddSearchSynonym, Recombee.ApiClient.ApiRequests.AddSeries, Recombee.ApiClient.ApiRequests.AddUser, Recombee.ApiClient.ApiRequests.AddUserProperty, Recombee.ApiClient.ApiRequests.Batch, Recombee.ApiClient.ApiRequests.DeleteAllSearchSynonyms, Recombee.ApiClient.ApiRequests.DeleteBookmark, Recombee.ApiClient.ApiRequests.DeleteCartAddition, Recombee.ApiClient.ApiRequests.DeleteDetailView, Recombee.ApiClient.ApiRequests.DeleteGroup, Recombee.ApiClient.ApiRequests.DeleteItem, Recombee.ApiClient.ApiRequests.DeleteItemProperty, Recombee.ApiClient.ApiRequests.DeletePurchase, Recombee.ApiClient.ApiRequests.DeleteRating, Recombee.ApiClient.ApiRequests.DeleteSearchSynonym, Recombee.ApiClient.ApiRequests.DeleteSeries, Recombee.ApiClient.ApiRequests.DeleteUser, Recombee.ApiClient.ApiRequests.DeleteUserProperty, Recombee.ApiClient.ApiRequests.DeleteViewPortion, Recombee.ApiClient.ApiRequests.GetItemPropertyInfo, Recombee.ApiClient.ApiRequests.GetItemValues, Recombee.ApiClient.ApiRequests.GetUserPropertyInfo, Recombee.ApiClient.ApiRequests.GetUserValues, Recombee.ApiClient.ApiRequests.InsertToGroup, Recombee.ApiClient.ApiRequests.InsertToSeries, Recombee.ApiClient.ApiRequests.ItemBasedRecommendation, Recombee.ApiClient.ApiRequests.ListGroupItems, Recombee.ApiClient.ApiRequests.ListGroups, Recombee.ApiClient.ApiRequests.ListItemBookmarks, Recombee.ApiClient.ApiRequests.ListItemCartAdditions, Recombee.ApiClient.ApiRequests.ListItemDetailViews, Recombee.ApiClient.ApiRequests.ListItemProperties, Recombee.ApiClient.ApiRequests.ListItemPurchases, Recombee.ApiClient.ApiRequests.ListItemRatings, Recombee.ApiClient.ApiRequests.ListItems, Recombee.ApiClient.ApiRequests.ListItemViewPortions, Recombee.ApiClient.ApiRequests.ListSearchSynonyms, Recombee.ApiClient.ApiRequests.ListSeries, Recombee.ApiClient.ApiRequests.ListSeriesItems, Recombee.ApiClient.ApiRequests.ListUserBookmarks, Recombee.ApiClient.ApiRequests.ListUserCartAdditions, Recombee.ApiClient.ApiRequests.ListUserDetailViews, Recombee.ApiClient.ApiRequests.ListUserProperties, Recombee.ApiClient.ApiRequests.ListUserPurchases, Recombee.ApiClient.ApiRequests.ListUserRatings, Recombee.ApiClient.ApiRequests.ListUsers, Recombee.ApiClient.ApiRequests.ListUserViewPortions, Recombee.ApiClient.ApiRequests.MergeUsers, Recombee.ApiClient.ApiRequests.RecommendItemsToItem, Recombee.ApiClient.ApiRequests.RecommendItemsToUser, Recombee.ApiClient.ApiRequests.RecommendNextItems, Recombee.ApiClient.ApiRequests.RecommendUsersToItem, Recombee.ApiClient.ApiRequests.RecommendUsersToUser, Recombee.ApiClient.ApiRequests.RemoveFromGroup, Recombee.ApiClient.ApiRequests.RemoveFromSeries, Recombee.ApiClient.ApiRequests.ResetDatabase, Recombee.ApiClient.ApiRequests.SearchItems, Recombee.ApiClient.ApiRequests.SetValues, Recombee.ApiClient.ApiRequests.SetViewPortion, and Recombee.ApiClient.ApiRequests.UserBasedRecommendation.

Public Member Functions
	Request (HttpMethod httpMethod, int timeoutMilliseconds, bool ensureHttps=false)
	Construct the request More...

abstract string	Path ()
	Returns URI to the endpoint including path parameters More...

abstract Dictionary< string, object >	BodyParameters ()
	Get body parameters More...

abstract Dictionary< string, object >	QueryParameters ()
	Get query parameters More...

Protected Member Functions
double	ConvertToUnixTimestamp (DateTime date)
	Returns Converts DateTime to UNIX timestamp (epoch) More...

Properties
TimeSpan	Timeout `[get, set]`
	Timeout for the request in milliseconds More...

bool	EnsureHttps `[get]`
	If true, HTTPS must be chosen over HTTP for this request More...

HttpMethod	RequestHttpMehod `[get]`
	Used HTTP method More...

Detailed Description

Base class for all the requests

Constructor & Destructor Documentation

◆ Request()

Recombee.ApiClient.ApiRequests.Request.Request	(	HttpMethod	httpMethod,
		int	timeoutMilliseconds,
		bool	ensureHttps = `false`
	)

inline

Construct the request

Parameters

httpMethod	Used HTTP method.
timeoutMilliseconds	Timeout for the request in milliseconds.
ensureHttps	If true, HTTPS must be chosen over HTTP for this request

Member Function Documentation

◆ BodyParameters()

abstract Dictionary<string, object> Recombee.ApiClient.ApiRequests.Request.BodyParameters ( )

pure virtual

Get body parameters

Returns: Dictionary containing values of body parameters (name of parameter: value of the parameter)

Implemented in Recombee.ApiClient.ApiRequests.RecommendItemsToItem, Recombee.ApiClient.ApiRequests.RecommendItemsToUser, Recombee.ApiClient.ApiRequests.RecommendUsersToUser, Recombee.ApiClient.ApiRequests.SearchItems, Recombee.ApiClient.ApiRequests.ItemBasedRecommendation, Recombee.ApiClient.ApiRequests.RecommendUsersToItem, Recombee.ApiClient.ApiRequests.UserBasedRecommendation, Recombee.ApiClient.ApiRequests.ListItems, Recombee.ApiClient.ApiRequests.ListUsers, Recombee.ApiClient.ApiRequests.AddPurchase, Recombee.ApiClient.ApiRequests.SetViewPortion, Recombee.ApiClient.ApiRequests.AddCartAddition, Recombee.ApiClient.ApiRequests.AddDetailView, Recombee.ApiClient.ApiRequests.AddRating, Recombee.ApiClient.ApiRequests.AddBookmark, Recombee.ApiClient.ApiRequests.InsertToSeries, Recombee.ApiClient.ApiRequests.AddItemProperty, Recombee.ApiClient.ApiRequests.RemoveFromSeries, Recombee.ApiClient.ApiRequests.AddUserProperty, Recombee.ApiClient.ApiRequests.InsertToGroup, Recombee.ApiClient.ApiRequests.AddSearchSynonym, Recombee.ApiClient.ApiRequests.RecommendNextItems, Recombee.ApiClient.ApiRequests.DeleteBookmark, Recombee.ApiClient.ApiRequests.DeleteCartAddition, Recombee.ApiClient.ApiRequests.DeleteDetailView, Recombee.ApiClient.ApiRequests.DeletePurchase, Recombee.ApiClient.ApiRequests.DeleteRating, Recombee.ApiClient.ApiRequests.DeleteViewPortion, Recombee.ApiClient.ApiRequests.MergeUsers, Recombee.ApiClient.ApiRequests.RemoveFromGroup, Recombee.ApiClient.ApiRequests.Batch, Recombee.ApiClient.ApiRequests.ListSearchSynonyms, Recombee.ApiClient.ApiRequests.DeleteItem, Recombee.ApiClient.ApiRequests.GetItemValues, Recombee.ApiClient.ApiRequests.GetUserValues, Recombee.ApiClient.ApiRequests.ListItemViewPortions, Recombee.ApiClient.ApiRequests.AddItem, Recombee.ApiClient.ApiRequests.DeleteGroup, Recombee.ApiClient.ApiRequests.DeleteSeries, Recombee.ApiClient.ApiRequests.DeleteUser, Recombee.ApiClient.ApiRequests.ListItemBookmarks, Recombee.ApiClient.ApiRequests.ListItemCartAdditions, Recombee.ApiClient.ApiRequests.ListItemDetailViews, Recombee.ApiClient.ApiRequests.ListItemPurchases, Recombee.ApiClient.ApiRequests.ListItemRatings, Recombee.ApiClient.ApiRequests.AddUser, Recombee.ApiClient.ApiRequests.DeleteItemProperty, Recombee.ApiClient.ApiRequests.DeleteSearchSynonym, Recombee.ApiClient.ApiRequests.DeleteUserProperty, Recombee.ApiClient.ApiRequests.GetItemPropertyInfo, Recombee.ApiClient.ApiRequests.GetUserPropertyInfo, Recombee.ApiClient.ApiRequests.ListUserViewPortions, Recombee.ApiClient.ApiRequests.AddGroup, Recombee.ApiClient.ApiRequests.AddSeries, Recombee.ApiClient.ApiRequests.ListGroupItems, Recombee.ApiClient.ApiRequests.ListSeriesItems, Recombee.ApiClient.ApiRequests.ListUserBookmarks, Recombee.ApiClient.ApiRequests.ListUserCartAdditions, Recombee.ApiClient.ApiRequests.ListUserDetailViews, Recombee.ApiClient.ApiRequests.ListUserPurchases, Recombee.ApiClient.ApiRequests.ListUserRatings, Recombee.ApiClient.ApiRequests.DeleteAllSearchSynonyms, Recombee.ApiClient.ApiRequests.ListItemProperties, Recombee.ApiClient.ApiRequests.ListUserProperties, Recombee.ApiClient.ApiRequests.ResetDatabase, Recombee.ApiClient.ApiRequests.SetValues, Recombee.ApiClient.ApiRequests.ListGroups, and Recombee.ApiClient.ApiRequests.ListSeries.

◆ ConvertToUnixTimestamp()

double Recombee.ApiClient.ApiRequests.Request.ConvertToUnixTimestamp ( DateTime date )

inlineprotected

Returns: Converts DateTime to UNIX timestamp (epoch)

◆ Path()

abstract string Recombee.ApiClient.ApiRequests.Request.Path ( )

pure virtual

Returns: URI to the endpoint including path parameters

Implemented in Recombee.ApiClient.ApiRequests.RecommendItemsToItem, Recombee.ApiClient.ApiRequests.RecommendItemsToUser, Recombee.ApiClient.ApiRequests.RecommendUsersToUser, Recombee.ApiClient.ApiRequests.SearchItems, Recombee.ApiClient.ApiRequests.ItemBasedRecommendation, Recombee.ApiClient.ApiRequests.RecommendUsersToItem, Recombee.ApiClient.ApiRequests.UserBasedRecommendation, Recombee.ApiClient.ApiRequests.ListItems, Recombee.ApiClient.ApiRequests.ListUsers, Recombee.ApiClient.ApiRequests.AddPurchase, Recombee.ApiClient.ApiRequests.SetViewPortion, Recombee.ApiClient.ApiRequests.AddCartAddition, Recombee.ApiClient.ApiRequests.AddDetailView, Recombee.ApiClient.ApiRequests.AddRating, Recombee.ApiClient.ApiRequests.AddBookmark, Recombee.ApiClient.ApiRequests.InsertToSeries, Recombee.ApiClient.ApiRequests.AddItemProperty, Recombee.ApiClient.ApiRequests.AddUserProperty, Recombee.ApiClient.ApiRequests.InsertToGroup, Recombee.ApiClient.ApiRequests.AddSearchSynonym, Recombee.ApiClient.ApiRequests.RemoveFromSeries, Recombee.ApiClient.ApiRequests.RecommendNextItems, Recombee.ApiClient.ApiRequests.Batch, Recombee.ApiClient.ApiRequests.MergeUsers, Recombee.ApiClient.ApiRequests.DeleteBookmark, Recombee.ApiClient.ApiRequests.DeleteCartAddition, Recombee.ApiClient.ApiRequests.DeleteDetailView, Recombee.ApiClient.ApiRequests.DeletePurchase, Recombee.ApiClient.ApiRequests.DeleteRating, Recombee.ApiClient.ApiRequests.DeleteViewPortion, Recombee.ApiClient.ApiRequests.RemoveFromGroup, Recombee.ApiClient.ApiRequests.ListSearchSynonyms, Recombee.ApiClient.ApiRequests.DeleteItem, Recombee.ApiClient.ApiRequests.GetItemValues, Recombee.ApiClient.ApiRequests.GetUserValues, Recombee.ApiClient.ApiRequests.ListItemViewPortions, Recombee.ApiClient.ApiRequests.AddItem, Recombee.ApiClient.ApiRequests.DeleteGroup, Recombee.ApiClient.ApiRequests.DeleteSeries, Recombee.ApiClient.ApiRequests.DeleteUser, Recombee.ApiClient.ApiRequests.ListItemBookmarks, Recombee.ApiClient.ApiRequests.ListItemCartAdditions, Recombee.ApiClient.ApiRequests.ListItemDetailViews, Recombee.ApiClient.ApiRequests.ListItemPurchases, Recombee.ApiClient.ApiRequests.ListItemRatings, Recombee.ApiClient.ApiRequests.AddUser, Recombee.ApiClient.ApiRequests.DeleteItemProperty, Recombee.ApiClient.ApiRequests.DeleteSearchSynonym, Recombee.ApiClient.ApiRequests.DeleteUserProperty, Recombee.ApiClient.ApiRequests.GetItemPropertyInfo, Recombee.ApiClient.ApiRequests.GetUserPropertyInfo, Recombee.ApiClient.ApiRequests.ListUserViewPortions, Recombee.ApiClient.ApiRequests.AddGroup, Recombee.ApiClient.ApiRequests.AddSeries, Recombee.ApiClient.ApiRequests.ListGroupItems, Recombee.ApiClient.ApiRequests.ListSeriesItems, Recombee.ApiClient.ApiRequests.ListUserBookmarks, Recombee.ApiClient.ApiRequests.ListUserCartAdditions, Recombee.ApiClient.ApiRequests.ListUserDetailViews, Recombee.ApiClient.ApiRequests.ListUserPurchases, Recombee.ApiClient.ApiRequests.ListUserRatings, Recombee.ApiClient.ApiRequests.SetItemValues, Recombee.ApiClient.ApiRequests.SetUserValues, Recombee.ApiClient.ApiRequests.DeleteAllSearchSynonyms, Recombee.ApiClient.ApiRequests.ListItemProperties, Recombee.ApiClient.ApiRequests.ListUserProperties, Recombee.ApiClient.ApiRequests.ResetDatabase, Recombee.ApiClient.ApiRequests.ListGroups, and Recombee.ApiClient.ApiRequests.ListSeries.

◆ QueryParameters()

abstract Dictionary<string, object> Recombee.ApiClient.ApiRequests.Request.QueryParameters ( )

pure virtual

Get query parameters

Returns: Dictionary containing values of query parameters (name of parameter: value of the parameter)

Implemented in Recombee.ApiClient.ApiRequests.RecommendItemsToItem, Recombee.ApiClient.ApiRequests.RecommendItemsToUser, Recombee.ApiClient.ApiRequests.RecommendUsersToUser, Recombee.ApiClient.ApiRequests.SearchItems, Recombee.ApiClient.ApiRequests.ItemBasedRecommendation, Recombee.ApiClient.ApiRequests.RecommendUsersToItem, Recombee.ApiClient.ApiRequests.UserBasedRecommendation, Recombee.ApiClient.ApiRequests.ListItems, Recombee.ApiClient.ApiRequests.ListUsers, Recombee.ApiClient.ApiRequests.AddPurchase, Recombee.ApiClient.ApiRequests.SetViewPortion, Recombee.ApiClient.ApiRequests.AddCartAddition, Recombee.ApiClient.ApiRequests.AddDetailView, Recombee.ApiClient.ApiRequests.AddRating, Recombee.ApiClient.ApiRequests.AddBookmark, Recombee.ApiClient.ApiRequests.InsertToSeries, Recombee.ApiClient.ApiRequests.AddItemProperty, Recombee.ApiClient.ApiRequests.AddUserProperty, Recombee.ApiClient.ApiRequests.InsertToGroup, Recombee.ApiClient.ApiRequests.AddSearchSynonym, Recombee.ApiClient.ApiRequests.RemoveFromSeries, Recombee.ApiClient.ApiRequests.RecommendNextItems, Recombee.ApiClient.ApiRequests.Batch, Recombee.ApiClient.ApiRequests.MergeUsers, Recombee.ApiClient.ApiRequests.DeleteBookmark, Recombee.ApiClient.ApiRequests.DeleteCartAddition, Recombee.ApiClient.ApiRequests.DeleteDetailView, Recombee.ApiClient.ApiRequests.DeletePurchase, Recombee.ApiClient.ApiRequests.DeleteRating, Recombee.ApiClient.ApiRequests.DeleteViewPortion, Recombee.ApiClient.ApiRequests.RemoveFromGroup, Recombee.ApiClient.ApiRequests.ListSearchSynonyms, Recombee.ApiClient.ApiRequests.DeleteItem, Recombee.ApiClient.ApiRequests.GetItemValues, Recombee.ApiClient.ApiRequests.GetUserValues, Recombee.ApiClient.ApiRequests.ListItemViewPortions, Recombee.ApiClient.ApiRequests.AddItem, Recombee.ApiClient.ApiRequests.DeleteGroup, Recombee.ApiClient.ApiRequests.DeleteSeries, Recombee.ApiClient.ApiRequests.DeleteUser, Recombee.ApiClient.ApiRequests.ListItemBookmarks, Recombee.ApiClient.ApiRequests.ListItemCartAdditions, Recombee.ApiClient.ApiRequests.ListItemDetailViews, Recombee.ApiClient.ApiRequests.ListItemPurchases, Recombee.ApiClient.ApiRequests.ListItemRatings, Recombee.ApiClient.ApiRequests.AddUser, Recombee.ApiClient.ApiRequests.DeleteItemProperty, Recombee.ApiClient.ApiRequests.DeleteSearchSynonym, Recombee.ApiClient.ApiRequests.DeleteUserProperty, Recombee.ApiClient.ApiRequests.GetItemPropertyInfo, Recombee.ApiClient.ApiRequests.GetUserPropertyInfo, Recombee.ApiClient.ApiRequests.ListUserViewPortions, Recombee.ApiClient.ApiRequests.AddGroup, Recombee.ApiClient.ApiRequests.AddSeries, Recombee.ApiClient.ApiRequests.ListGroupItems, Recombee.ApiClient.ApiRequests.ListSeriesItems, Recombee.ApiClient.ApiRequests.ListUserBookmarks, Recombee.ApiClient.ApiRequests.ListUserCartAdditions, Recombee.ApiClient.ApiRequests.ListUserDetailViews, Recombee.ApiClient.ApiRequests.ListUserPurchases, Recombee.ApiClient.ApiRequests.ListUserRatings, Recombee.ApiClient.ApiRequests.SetValues, Recombee.ApiClient.ApiRequests.DeleteAllSearchSynonyms, Recombee.ApiClient.ApiRequests.ListItemProperties, Recombee.ApiClient.ApiRequests.ListUserProperties, Recombee.ApiClient.ApiRequests.ResetDatabase, Recombee.ApiClient.ApiRequests.ListGroups, and Recombee.ApiClient.ApiRequests.ListSeries.

Property Documentation

◆ EnsureHttps

bool Recombee.ApiClient.ApiRequests.Request.EnsureHttps

get

If true, HTTPS must be chosen over HTTP for this request

◆ RequestHttpMehod

HttpMethod Recombee.ApiClient.ApiRequests.Request.RequestHttpMehod

get

Used HTTP method

◆ Timeout

TimeSpan Recombee.ApiClient.ApiRequests.Request.Timeout

getset

Timeout for the request in milliseconds

The documentation for this class was generated from the following file:

Src/Recombee.ApiClient/ApiRequests/Request.cs