C# Class DineroPortableClientSDK.Contacts.DineroContacts

Inheritance: DineroLibaryBase
Datei anzeigen Open project: DineroRegnskab/dinero-csharp-sdk

Public Methods

Method Description
Add ( ContactCreate modelToCreate ) : ContactCreatedResult

Add the contact to the organization's contacts.

AddAsync ( ContactCreate modelToCreate ) : Task

Add the contact to the organization's contacts.

Delete ( System.Guid guid ) : void

Delete the organization's contact with the given guid.

DeleteAsync ( System.Guid guid ) : System.Threading.Tasks.Task

Delete the organization's contact with the given guid.

Get ( System.Guid guid ) : Contact

Gets the organization's contact with the given guid.

GetAsync ( System.Guid guid ) : Task

Gets the organization's contact with the given guid.

GetList ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, bool includeDeleted = null, int page = null, int pageSize = null ) : ContactCollection

Gets a list the organization's contacts. If no parameters are given it returns all (not deleted) contacts.

GetListAsync ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, bool deletedOnly = null, int page = null, int pageSize = null ) : Task

Gets a list the organization's contacts. If no parameters are given it returns all (not deleted) contacts.

Update ( System.Guid guid, ContactUpdate updatedModel ) : void

Update the organization's contact.

UpdateAsync ( System.Guid guid, ContactUpdate updatedModel ) : System.Threading.Tasks.Task

Update the organization's contact.

Private Methods

Method Description
DineroContacts ( Dinero dinero ) : System

Method Details

Add() public method

Add the contact to the organization's contacts.
public Add ( ContactCreate modelToCreate ) : ContactCreatedResult
modelToCreate ContactCreate The contact to be added.
return ContactCreatedResult

AddAsync() public method

Add the contact to the organization's contacts.
public AddAsync ( ContactCreate modelToCreate ) : Task
modelToCreate ContactCreate The contact to be added.
return Task

Delete() public method

Delete the organization's contact with the given guid.
public Delete ( System.Guid guid ) : void
guid System.Guid The guid of the contact to delete
return void

DeleteAsync() public method

Delete the organization's contact with the given guid.
public DeleteAsync ( System.Guid guid ) : System.Threading.Tasks.Task
guid System.Guid The guid of the contact to delete
return System.Threading.Tasks.Task

Get() public method

Gets the organization's contact with the given guid.
public Get ( System.Guid guid ) : Contact
guid System.Guid
return Contact

GetAsync() public method

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

GetList() public method

Gets a list the organization's contacts. If no parameters are given it returns all (not deleted) contacts.
public GetList ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, bool includeDeleted = null, int page = null, int pageSize = null ) : ContactCollection
fields string Comma separated list of properties to fetch in the resultset, e.g. "Name,ContactGuid,IsPro". /// If left empty, the server default is used.
queryFilter string Filter specific for contacts. Filtering can be applied to following fields: ExternalReference,Name, Email,IsPerson,VatNumber,EanNumber. See API documentation for filtering format. If left empty no filtering is applied.
changesSince System.DateTime Only return contacts that was created, deleted or updated at or after given time. If left empty, this filter will not be applyed, and contacts will be returned regardless of change history. The time must be UTC.
includeDeleted bool Include deleted contacts. 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
return ContactCollection

GetListAsync() public method

Gets a list the organization's contacts. If no parameters are given it returns all (not deleted) contacts.
public GetListAsync ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, bool deletedOnly = null, int page = null, int pageSize = null ) : Task
fields string Comma separated list of properties to fetch in the resultset, e.g. "Name,ContactGuid,ExternalReference". /// If left empty, the server default is used.
queryFilter string Filter specific for contacts. Filtering can be applied to following fields: ExternalReference,Name, Email,IsPerson,VatNumber,EanNumber. See API documentation for filtering format. If left empty no filtering is applied.
changesSince System.DateTime Only return contacts that was created, deleted or updated at or after given time. If left empty, this filter will not be applyed, and contacts will be returned regardless of change history. The time must be UTC.
deletedOnly bool Include deleted contacts. 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
return Task

Update() public method

Update the organization's contact.
public Update ( System.Guid guid, ContactUpdate updatedModel ) : void
guid System.Guid The guid of the contact to update
updatedModel ContactUpdate The updated contact
return void

UpdateAsync() public method

Update the organization's contact.
public UpdateAsync ( System.Guid guid, ContactUpdate updatedModel ) : System.Threading.Tasks.Task
guid System.Guid The guid of the contact to update
updatedModel ContactUpdate The updated contact
return System.Threading.Tasks.Task