C# Class DineroPortableClientSDK.TradeOffers.DineroTradeOffers

Inheritance: DineroLibaryBase
Exibir arquivo Open project: DineroRegnskab/dinero-csharp-sdk

Public Methods

Method Description
Add ( TradeOfferCreate modelToCreate ) : CreatedResponse

Add the tradeoffer to the organization's tradeoffers.
AddAsync ( TradeOfferCreate modelToCreate ) : Task

Add the tradeoffer to the organization's tradeoffers.
Delete ( System.Guid guid, string timestamp = null ) : void

Delete trade offer.
DeleteAsync ( System.Guid guid, string timestamp = null ) : System.Threading.Tasks.Task

Delete trade offer.
DownloadPdf ( System.Guid guid ) : Stream

Get a stream of the tradeoffer pdf. This endpoint is not available for API partners yet.
DownloadPdfAsync ( System.Guid guid ) : Task

Get a stream of the tradeoffer pdf. This endpoint is not available for API partners yet.
GenerateInvoice ( System.Guid guid, string timestamp = null ) : CreatedResponse

Generate an invoice based on the given trade offer guid.
GenerateInvoiceAsync ( System.Guid guid, string timestamp = null ) : Task

Generate an invoice based on the given trade offer guid.
Get ( System.Guid guid ) : TradeOffer

Gets the organization's tradeoffer with the given guid.
GetAsync ( System.Guid guid ) : Task

Gets the organization's tradeoffer with the given guid.
GetList ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, bool deletedOnly = null, int page = null, int pageSize = null ) : TradeOfferCollection

Retrieve a list of trade offers for the organization.
GetListAsync ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, bool deletedOnly = null, int page = null, int pageSize = null ) : Task

Retrieve a list of trade offers for the organization.
SendEmail ( System.Guid guid, MailOut mailoutModel = null ) : void

Send an email with a link to the tradeoffer
SendEmailAsync ( System.Guid guid, MailOut mailoutModel = null ) : System.Threading.Tasks.Task

Send an email with a link to the tradeoffer
Update ( System.Guid guid, TradeOfferUpdate updatedModel ) : UpdatedResponse

Update the organization's trade offer.
UpdateAsync ( System.Guid guid, TradeOfferUpdate updatedModel ) : Task

Update the organization's trade offer.

Private Methods

Method Description
DineroTradeOffers ( Dinero dinero ) : System

Method Details

Add() public method

Add the tradeoffer to the organization's tradeoffers.
public Add ( TradeOfferCreate modelToCreate ) : CreatedResponse
modelToCreate TradeOfferCreate The tradeoffer to create
return DineroPortableClientSDK.ResponseModels.CreatedResponse

AddAsync() public method

Add the tradeoffer to the organization's tradeoffers.
public AddAsync ( TradeOfferCreate modelToCreate ) : Task
modelToCreate TradeOfferCreate The tradeoffer to create
return Task

Delete() public method

Delete trade offer.
public Delete ( System.Guid guid, string timestamp = null ) : void
guid System.Guid The tradeoffer guid
timestamp string optional timestamp to verify version before deletion
return void

DeleteAsync() public method

Delete trade offer.
public DeleteAsync ( System.Guid guid, string timestamp = null ) : System.Threading.Tasks.Task
guid System.Guid The tradeoffer guid
timestamp string optional timestamp to verify version before deletion
return System.Threading.Tasks.Task

DownloadPdf() public method

Get a stream of the tradeoffer pdf. This endpoint is not available for API partners yet.
public DownloadPdf ( System.Guid guid ) : Stream
guid System.Guid tradeoffer guid
return Stream

DownloadPdfAsync() public method

Get a stream of the tradeoffer pdf. This endpoint is not available for API partners yet.
public DownloadPdfAsync ( System.Guid guid ) : Task
guid System.Guid tradeoffer guid
return Task

GenerateInvoice() public method

Generate an invoice based on the given trade offer guid.
public GenerateInvoice ( System.Guid guid, string timestamp = null ) : CreatedResponse
guid System.Guid guid of the trade offer
timestamp string optional timestamp to verify version before generating invoice
return DineroPortableClientSDK.ResponseModels.CreatedResponse

GenerateInvoiceAsync() public method

Generate an invoice based on the given trade offer guid.
public GenerateInvoiceAsync ( System.Guid guid, string timestamp = null ) : Task
guid System.Guid guid of the trade offer
timestamp string optional timestamp to verify version before generating invoice
return Task

Get() public method

Gets the organization's tradeoffer with the given guid.
public Get ( System.Guid guid ) : TradeOffer
guid System.Guid The tradeoffer guid
return TradeOffer

GetAsync() public method

Gets the organization's tradeoffer with the given guid.
public GetAsync ( System.Guid guid ) : Task
guid System.Guid The tradeoffer guid
return Task

GetList() public method

Retrieve a list of trade offers for the organization.
public GetList ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, bool deletedOnly = null, int page = null, int pageSize = null ) : TradeOfferCollection
fields string A comma separated list of fields to include in the response. /// Possible values are: /// number, guid, timeStamp, contactName, contactGuid, address, date, comment, description, externalReference, language, currency, /// totalExclVat, totalVatableAmount, totalInclVat, totalNonVatableAmount, totalVat, hasGeneratedAnyVouchers, /// createdAt, updatedAt and deletedAt. If left empty it defaults to guid, contactName, date, description. Note that ProductLines and TotalLines are NOT available when fecthing a list. ///
queryFilter string Filter specific for contacts. Filtering can be applied to following fields: /// ExternalReference, ContactName, Address, Comment, Description, HasGeneratedAnyVouchers and Currency. /// See API documentation for filtering format. /// If left empty no filtering is applied.
changesSince System.DateTime [Generic Filter Option] Only return trade offers that was created, deleted or updated at or after given time. /// If left empty, this filter will not be applied, and trade offers will be returned regardless of change history. /// The time must be UTC and in the format 'YYYY-MM-DDTHH:mm:ssZ' example: '2015-08-18T06:36:22Z'.
deletedOnly bool [Generic Filter Option] Only select deleted trade offers. If left empty, will defaults to false.
page int The 0-based page number
pageSize int The maximum number of items to include in a page. Maximum 1000.
return TradeOfferCollection

GetListAsync() public method

Retrieve a list of trade offers for the organization.
public GetListAsync ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, bool deletedOnly = null, int page = null, int pageSize = null ) : Task
fields string A comma separated list of fields to include in the response. /// Possible values are: /// number, guid, timeStamp, contactName, contactGuid, address, date, comment, description, externalReference, language, currency, /// totalExclVat, totalVatableAmount, totalInclVat, totalNonVatableAmount, totalVat, hasGeneratedAnyVouchers, /// createdAt, updatedAt and deletedAt. If left empty it defaults to guid, contactName, date, description. Note that ProductLines and TotalLines are NOT available when fecthing a list. ///
queryFilter string Filter specific for contacts. Filtering can be applied to following fields: /// ExternalReference, ContactName, Address, Comment, Description, HasGeneratedAnyVouchers and Currency. /// See API documentation for filtering format. /// If left empty no filtering is applied.
changesSince System.DateTime [Generic Filter Option] Only return trade offers that was created, deleted or updated at or after given time. /// If left empty, this filter will not be applied, and trade offers will be returned regardless of change history. /// The time must be UTC and in the format 'YYYY-MM-DDTHH:mm:ssZ' example: '2015-08-18T06:36:22Z'.
deletedOnly bool [Generic Filter Option] Only select deleted trade offers. If left empty, will defaults to false.
page int The 0-based page number
pageSize int The maximum number of items to include in a page. Maximum 1000.
return Task

SendEmail() public method

Send an email with a link to the tradeoffer
public SendEmail ( System.Guid guid, MailOut mailoutModel = null ) : void
guid System.Guid Guid of the tradeoffer
mailoutModel DineroPortableClientSDK.Mailouts.MailOut Model with data to send email of the tradeoffer
return void

SendEmailAsync() public method

Send an email with a link to the tradeoffer
public SendEmailAsync ( System.Guid guid, MailOut mailoutModel = null ) : System.Threading.Tasks.Task
guid System.Guid Guid of the tradeoffer
mailoutModel DineroPortableClientSDK.Mailouts.MailOut Model with data to send email of the tradeoffer
return System.Threading.Tasks.Task

Update() public method

Update the organization's trade offer.
public Update ( System.Guid guid, TradeOfferUpdate updatedModel ) : UpdatedResponse
guid System.Guid The guid of the trade offer to update
updatedModel TradeOfferUpdate The updated trade offer
return UpdatedResponse

UpdateAsync() public method

Update the organization's trade offer.
public UpdateAsync ( System.Guid guid, TradeOfferUpdate updatedModel ) : Task
guid System.Guid The guid of the trade offer to update
updatedModel TradeOfferUpdate The updated trade offer
return Task