C# Class DineroPortableClientSDK.Products.DineroProducts

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

Public Methods

Method Description
Add ( ProductCreateModel modelToCreate ) : ProductCreatedResult

Add a new product to the organization

AddAsync ( ProductCreateModel modelToCreate ) : Task

Add a new product to the organization

Delete ( System.Guid guid ) : void

Delete a product in the organization.

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

Delete a product in the organization.

DineroProducts ( Dinero dinero ) : System
Get ( System.Guid guid ) : Product

Gets Product Information for the product with the given Id

GetAsync ( System.Guid guid ) : Task

Gets Product Information for the product with the given Id

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

Retrieve a list of products for the organization.

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

Retrieve a list of products for the organization.

Update ( System.Guid guid, ProductUpdateModel productUpdateModel ) : void

Update a product in the organization.

UpdateAsync ( System.Guid guid, ProductUpdateModel productUpdateModel ) : System.Threading.Tasks.Task

Update a product in the organization.

Method Details

Add() public method

Add a new product to the organization
public Add ( ProductCreateModel modelToCreate ) : ProductCreatedResult
modelToCreate ProductCreateModel Content of the new product
return ProductCreatedResult

AddAsync() public method

Add a new product to the organization
public AddAsync ( ProductCreateModel modelToCreate ) : Task
modelToCreate ProductCreateModel Content of the new product
return Task

Delete() public method

Delete a product in the organization.
public Delete ( System.Guid guid ) : void
guid System.Guid The guid of the product to delete
return void

DeleteAsync() public method

Delete a product in the organization.
public DeleteAsync ( System.Guid guid ) : System.Threading.Tasks.Task
guid System.Guid The guid of the product to delete
return System.Threading.Tasks.Task

DineroProducts() public method

public DineroProducts ( Dinero dinero ) : System
dinero Dinero
return System

Get() public method

Gets Product Information for the product with the given Id
public Get ( System.Guid guid ) : Product
guid System.Guid Unique identifier for the Product
return Product

GetAsync() public method

Gets Product Information for the product with the given Id
public GetAsync ( System.Guid guid ) : Task
guid System.Guid Unique identifier for the Product
return Task

GetList() public method

Retrieve a list of products for the organization.
public GetList ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, int page = null, int pageSize = null ) : ProductCollection
fields string A comma separated list of fields to include in the response. /// Possible values are Name,Quantity,Unit,AccountNumber,BaseAmountValue,CreatedAt,UpdatedAt and DeletedAt. /// Notice that it's not case sensitive, the property name will be returned the way you request it. If left empty it defaults to name (notice small start letter).
queryFilter string Filter specific for products. Filtering can be applied to following fields: name,quantity,productnumber,unitkey,accountid,productid /// ExternalReference . See API documentation for filtering format. If left empty no filtering is applied.
changesSince System.DateTime [Generic Filter Option] Only return products that was created, deleted or updated at or after given time. /// If left empty, this filter will not be applied, and products 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'.
page int The 0-based page number
pageSize int The maximum number of items to include in a page. Maximum 1000.
return ProductCollection

GetListAsync() public method

Retrieve a list of products for the organization.
public GetListAsync ( string fields = null, string queryFilter = null, System.DateTime changesSince = null, int page = null, int pageSize = null ) : Task
fields string A comma separated list of fields to include in the response. /// Possible values are Name,Quantity,Unit,AccountNumber,BaseAmountValue,CreatedAt,UpdatedAt and DeletedAt. /// Notice that it's not case sensitive, the property name will be returned the way you request it. If left empty it defaults to name (notice small start letter).
queryFilter string Filter specific for products. Filtering can be applied to following fields: name,quantity,productnumber,unitkey,accountid,productid /// ExternalReference . See API documentation for filtering format. If left empty no filtering is applied.
changesSince System.DateTime [Generic Filter Option] Only return products that was created, deleted or updated at or after given time. /// If left empty, this filter will not be applied, and products 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'.
page int The 0-based page number
pageSize int The maximum number of items to include in a page. Maximum 1000.
return Task

Update() public method

Update a product in the organization.
public Update ( System.Guid guid, ProductUpdateModel productUpdateModel ) : void
guid System.Guid The guid of the product to update
productUpdateModel ProductUpdateModel The updated product
return void

UpdateAsync() public method

Update a product in the organization.
public UpdateAsync ( System.Guid guid, ProductUpdateModel productUpdateModel ) : System.Threading.Tasks.Task
guid System.Guid The guid of the product to update
productUpdateModel ProductUpdateModel The updated product
return System.Threading.Tasks.Task