Class GiftCardService

Namespace

Dynamicweb.Ecommerce.GiftCards

Assembly

Dynamicweb.Ecommerce.dll

public class GiftCardService

Inheritance

object

GiftCardService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GiftCardService()

public GiftCardService()

Methods

CreateGiftCards(Order)

Creates GiftCards for an order

public virtual void CreateGiftCards(Order order)

Parameters

order Order

The Order

DecryptCode(string)

Returns decrypted input string

public virtual string DecryptCode(string input)

Parameters

input string

String value

Returns

string

DeleteGiftCard(GiftCard)

Deletes the giftCard.

public virtual void DeleteGiftCard(GiftCard giftCard)

Parameters

giftCard GiftCard

DeleteGiftCardTransaction(GiftCardTransaction)

Deletes the giftCard transaction.

public virtual void DeleteGiftCardTransaction(GiftCardTransaction transaction)

Parameters

transaction GiftCardTransaction

EncryptCode(string)

Returns encrypted input string

public virtual string EncryptCode(string input)

Parameters

input string

String value

Returns

string

GetAllGiftCards()

Retrieve all GiftCards

public virtual IEnumerable<GiftCard> GetAllGiftCards()

Returns

IEnumerable<GiftCard>

GetGiftCardBalance(GiftCard)

Gets remaining balance for given gift card

public virtual double GetGiftCardBalance(GiftCard giftCard)

Parameters

giftCard GiftCard

The gift card

Returns

double

GetGiftCardByCode(string, bool)

Retrieve GiftCard by code

public virtual GiftCard? GetGiftCardByCode(string giftCardCode, bool encoded)

Parameters

giftCardCode string

GiftCard code

encoded bool

Boolean value indicates if code is already encoded

Returns

GiftCard

GetGiftCardById(string)

Retrieve GiftCard by id

public virtual GiftCard? GetGiftCardById(string giftCardId)

Parameters

giftCardId string

GiftCard id

Returns

GiftCard

GetGiftCardTransaction(int)

Gets gift card transaction by transaction id.

public virtual GiftCardTransaction? GetGiftCardTransaction(int transactionId)

Parameters

transactionId int

Transaction id

Returns

GiftCardTransaction

GetGiftCardsForOrder(string)

Retrieve GiftCards for the order

public virtual IEnumerable<GiftCard> GetGiftCardsForOrder(string orderId)

Parameters

orderId string

The Order id

Returns

IEnumerable<GiftCard>

GetGiftCardsForOrderLine(string)

Retrieve GiftCards for the order line

public virtual GiftCard? GetGiftCardsForOrderLine(string orderLineId)

Parameters

orderLineId string

The OrderLine id

Returns

GiftCard

GetTransactionsForGiftCard(string)

Gets all transactions for given GiftCard ID

public virtual IEnumerable<GiftCardTransaction> GetTransactionsForGiftCard(string giftCardId)

Parameters

giftCardId string

GiftCard id

Returns

IEnumerable<GiftCardTransaction>

SaveGiftCard(GiftCard)

Saves GiftCard to the database.

public virtual void SaveGiftCard(GiftCard giftCard)

Parameters

giftCard GiftCard

SaveGiftCardTransaction(GiftCardTransaction)

Saves GiftCard transaction to the database.

public virtual void SaveGiftCardTransaction(GiftCardTransaction transaction)

Parameters

transaction GiftCardTransaction

SetCardAsExpired(GiftCard)

Makes the gift card just expired.

public virtual void SetCardAsExpired(GiftCard giftCard)

Parameters

giftCard GiftCard

UseGiftCards(Order)

Make transactions for each order line based on GiftCard code discount

public virtual void UseGiftCards(Order order)

Parameters

order Order

The Order