Add cart addition More...

Inheritance diagram for Recombee.ApiClient.ApiRequests.AddCartAddition:

Collaboration diagram for Recombee.ApiClient.ApiRequests.AddCartAddition:

Public Member Functions
	AddCartAddition (string userId, string itemId, DateTime? timestamp=null, bool? cascadeCreate=null, double? amount=null, double? price=null, string recommId=null, Dictionary< string, object > additionalData=null)
	Construct the request More...

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

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

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

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

Properties
string	UserId `[get]`
	User who added the item to the cart More...

string	ItemId `[get]`
	Item added to the cart More...

DateTime?	Timestamp `[get]`
	UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time. More...

bool?	CascadeCreate `[get]`
	Sets whether the given user/item should be created if not present in the database. More...

double?	Amount `[get]`
	Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2. More...

double?	Price `[get]`
	Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given. More...

string	RecommId `[get]`
	If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation. More...

Dictionary< string, object >	AdditionalData `[get]`
	A dictionary of additional data for the interaction. More...

Properties inherited from Recombee.ApiClient.ApiRequests.Request
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...

Additional Inherited Members
Protected Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
double	ConvertToUnixTimestamp (DateTime date)
	Returns Converts DateTime to UNIX timestamp (epoch) More...

Detailed Description

Add cart addition

Adds a cart addition of a given item made by a given user.

Constructor & Destructor Documentation

◆ AddCartAddition()

Recombee.ApiClient.ApiRequests.AddCartAddition.AddCartAddition	(	string	userId,
		string	itemId,
		DateTime?	timestamp = `null`,
		bool?	cascadeCreate = `null`,
		double?	amount = `null`,
		double?	price = `null`,
		string	recommId = `null`,
		Dictionary< string, object >	additionalData = `null`
	)

inline

Construct the request

Parameters

userId	User who added the item to the cart
itemId	Item added to the cart
timestamp	UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
cascadeCreate	Sets whether the given user/item should be created if not present in the database.
amount	Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2.
price	Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
recommId	If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
additionalData	A dictionary of additional data for the interaction.

Member Function Documentation

◆ BodyParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.AddCartAddition.BodyParameters ( )

inlinevirtual

Get body parameters

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

Implements Recombee.ApiClient.ApiRequests.Request.

◆ Path()

override string Recombee.ApiClient.ApiRequests.AddCartAddition.Path ( )

inlinevirtual

Returns: URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.AddCartAddition.QueryParameters ( )

inlinevirtual

Get query parameters

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

Implements Recombee.ApiClient.ApiRequests.Request.

Property Documentation

◆ AdditionalData

Dictionary<string, object> Recombee.ApiClient.ApiRequests.AddCartAddition.AdditionalData

get

A dictionary of additional data for the interaction.

◆ Amount

double? Recombee.ApiClient.ApiRequests.AddCartAddition.Amount

get

Amount (number) added to cart. The default is 1. For example if user-x adds two item-y during a single order (session...), the amount should equal to 2.

◆ CascadeCreate

bool? Recombee.ApiClient.ApiRequests.AddCartAddition.CascadeCreate

get

Sets whether the given user/item should be created if not present in the database.

◆ ItemId

string Recombee.ApiClient.ApiRequests.AddCartAddition.ItemId

get

Item added to the cart

◆ Price

double? Recombee.ApiClient.ApiRequests.AddCartAddition.Price

get

Price of the added item. If amount is greater than 1, sum of prices of all the items should be given.

◆ RecommId

string Recombee.ApiClient.ApiRequests.AddCartAddition.RecommId

get

If this cart addition is based on a recommendation request, recommId is the id of the clicked recommendation.

◆ Timestamp

DateTime? Recombee.ApiClient.ApiRequests.AddCartAddition.Timestamp

get

UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

◆ UserId

string Recombee.ApiClient.ApiRequests.AddCartAddition.UserId

get

User who added the item to the cart

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

Src/Recombee.ApiClient/ApiRequests/AddCartAddition.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AddCartAddition()

Member Function Documentation

◆ BodyParameters()

◆ Path()

◆ QueryParameters()

Property Documentation

◆ AdditionalData

◆ Amount

◆ CascadeCreate

◆ ItemId

◆ Price

◆ RecommId

◆ Timestamp

◆ UserId