MoxiWorks.Platform.BuyerTransactionService Class Reference

Moxi Works Platform BuyerTransaction entities represent buyer-side transactions that agents are working on. More...

Inheritance diagram for MoxiWorks.Platform.BuyerTransactionService:

Public Member Functions
	BuyerTransactionService (IMoxiWorksClient client)
async Task< Response< BuyerTransaction > >	CreateBuyerTransactionAsync (BuyerTransaction buyerTransaction)
	Create new BuyerTransaction More...
async Task< Response< BuyerTransaction > >	UpdateBuyerTransactionAsync (BuyerTransaction buyerTransaction)
	Update existing BuyerTransaction More...
async Task< Response< BuyerTransaction > >	GetBuyerTransactionAsync (string agentId, AgentIdType agentIdType, string moxiWorksTransactionId)
	Get a BuyerTransaction More...
async Task< Response< BuyerTransactionResults > >	GetBuyerTransactionsAsync (string agentId, AgentIdType agentIdType, string moxiworksContactId=null, string partnerContactId=null, int pageNumber=1)
	Get a a Collection of BuyerTransactions. More...

Properties
IMoxiWorksClient	Client [get, set]
Properties inherited from MoxiWorks.Platform.Interfaces.IBuyerTransactionService
IMoxiWorksClient	Client [get, set]

Detailed Description

Moxi Works Platform BuyerTransaction entities represent buyer-side transactions that agents are working on.

Member Function Documentation

CreateBuyerTransactionAsync()

async Task<Response<BuyerTransaction> > MoxiWorks.Platform.BuyerTransactionService.CreateBuyerTransactionAsync

(

BuyerTransaction

buyerTransaction

)

Create new BuyerTransaction

Parameters

buyerTransaction

BuyerTransaction you want to create.

Returns

The created BuyerTransaction

Implements MoxiWorks.Platform.Interfaces.IBuyerTransactionService.

GetBuyerTransactionAsync()

async Task<Response<BuyerTransaction> > MoxiWorks.Platform.BuyerTransactionService.GetBuyerTransactionAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	moxiWorksTransactionId
	)

Get a BuyerTransaction

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Buyer Transaction entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Buyer Transaction entry request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Buyer Transaction entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Buyer Transaction request to be accepted. Agent ID for your Buyer Transaction request to be accepted.

Parameters

agentIdType	What agentId type you are using.
moxiWorksTransactionId	This is the Moxi Works Platform ID of the BuyerTransaction. This will be an RFC 4122 compliant UUID.

Returns

Response containing the expected BuyerTransaction of an empty transaction object

Implements MoxiWorks.Platform.Interfaces.IBuyerTransactionService.

GetBuyerTransactionsAsync()

async Task<Response<BuyerTransactionResults> > MoxiWorks.Platform.BuyerTransactionService.GetBuyerTransactionsAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	moxiworksContactId = null,
		string	partnerContactId = null,
		int	pageNumber = 1
	)

Get a a Collection of BuyerTransactions.

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Buyer Transaction entry entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Buyer Transaction entry request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Buyer Transaction entry entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Buyer Transaction entry request to be accepted. Agent ID for your Buyer Transaction entry request to be accepted.

Parameters

agentIdType	What agentId type you are using.
moxiworksContactId	This is the Moxi Works Platform ID of the Contact for which you are searching associated BuyerTransaction objects. This will be an RFC 4122 compliant UUID. You can use either MoxiworksContactId or partner_contact_id when searching for BuyerTransaction objects associated with a specific Contact.
partnerContactId	This is the unique identifer you use in your system that has been associated with the Contact you want to find BuyerTransaction objects for. You can use either MoxiworksContactId or PartnerContactId when searching for BuyerTransaction objects associated with a specific Contact.
pageNumber	Page of BuyerTransaction records to return. Use if TotalPages indicates that there is more than one page of data available.

Returns

A Collection of Buyer Transactions.

Implements MoxiWorks.Platform.Interfaces.IBuyerTransactionService.

UpdateBuyerTransactionAsync()

async Task<Response<BuyerTransaction> > MoxiWorks.Platform.BuyerTransactionService.UpdateBuyerTransactionAsync

(

BuyerTransaction

buyerTransaction

)

Update existing BuyerTransaction

Parameters

buyerTransaction

BuyerTransaction you want to update.

Returns

Implements MoxiWorks.Platform.Interfaces.IBuyerTransactionService.

---

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

• BuyerTransactionService.cs