LicenseSpring Management .Net SDK 1.10.1
Easily add Software Licensing to your application
Loading...
Searching...
No Matches
LicenseSpring.CustomerService Class Reference

Implements ICustomerService interface. More...

Inheritance diagram for LicenseSpring.CustomerService:
LicenseSpring.BaseService LicenseSpring.ICustomerService LicenseSpring.IService LicenseSpring.IService

Public Member Functions

void AddLabelToCustomer (uint labelId, ulong customerId)
 Adds a label to customer.
Parameters
labelIdId of the label to add.
customerIdId of the customer to be updated.

 
Customer CreateCustomer (CreateCustomerDto dto)
 Creates a new customer.
Parameters
dtoCustomer dto with information about new customer.

 
CustomerAccount CreateCustomerAccount (CustomerAccount account)
 Creates a customer account if requesting manager has access permissions to it.
Parameters
accountCustomer account to create. The Code field is required and must be unique.

 
CustomerLabel CreateCustomerLabel (CustomerLabel label)
 Creates a customer label.
Parameters
labelLabel to create.

 
string DeleteCustomer (ulong customerId)
 Deletes the customer.
Parameters
customerIdThe Id of the customer that will be deleted.

 
void DeleteCustomerAccount (CustomerAccount account)
 Deletes a customer account.
Parameters
accountCustomer account to delete. The Id field must be set.

 
void DeleteCustomerLabel (CustomerLabel label)
 Deletes a customer label.
Parameters
labelLabel to delete.

 
Customer EditCustomer (Customer customer)
 Updates information about a customer.
Parameters
customerCustomer that was updated.

 
CustomerAccount EditCustomerAccount (CustomerAccount account)
 Updates a customer account if requesting manager has access permissions to it.
Parameters
accountCustomer account with updated fields. The Id field must be set; if the Code field is set, it must be unique.

 
CustomerLabel EditCustomerLabel (CustomerLabel label)
 Updates information about a customer label.
Parameters
labelLabel that was updated.

 
CustomerAccount[] ListCustomerAccounts (BaseListDto dto, out uint Count)
 Shows all customer accounts the requesting manager has access permissions to.
Parameters
dtoData transfer object that is used for searching through all customer accounts.
countQuantity of customers, use for iteration of the result pages.

 
CustomerLabel[] ListCustomerLabels (BaseListDto dto, out uint Count)
 Returns all customer labels.
Parameters
dtoData transfer object that is used for searching through all customer labels.
countQuantity of customers, use for iteration of the result pages.

 
Customer[] ListCustomers (ListCustomersRequestDto dto, out uint Count)
 Returns all customers.
Parameters
dtoData transfer object that is used for searching through all customers.
countQuantity of customers, use for iteration of the result pages.

 
string MergeCustomers (ulong customerId, ulong customerToMergeId)
 Merges once customer into another if requesting manager has access permissions to it.Updates customer on all orders from the customer to merge to the customer provided in the first parameter and deletes the customer to merge.
 
void RemoveLabelFromCustomer (CustomerLabel label)
 Removes a label from customer.
Parameters
labelLabel to be removed.

 
- Public Member Functions inherited from LicenseSpring.BaseService
void Initialize (ManagementConfiguration configuration)
 Initialize management service with given configuration.
Parameters
configurationManagementConfiguration object to use
Exceptions
System.ArgumentNullExceptionThrown when configuration is null

 
bool IsInitialized ()
 Check whether management service has been initialized.
Returns
True if management service has been initialized and ready to use or false otherwise

 
bool IsOnline (bool throwExceptions=false)
 Helper method, it checks connection to the LicenseSpring platform.
Parameters
throwExceptionsBoolean value indicating whether this method should throw exceptions, by default it's false.
Returns
True if SDK is able to connect to the LicenseSpring platform and false otherwise.
Exceptions
System.InvalidOperationExceptionThrown when license manager is not initialized
LicenseSpring.NetworkExceptionIn case of network errors, e.g. no Internet connection or operation timed out.

 

Detailed Description

Implements ICustomerService interface.

Member Function Documentation

◆ AddLabelToCustomer()

void LicenseSpring.CustomerService.AddLabelToCustomer ( uint  labelId,
ulong  customerId 
)

Adds a label to customer.

Parameters
labelIdId of the label to add.
customerIdId of the customer to be updated.

Implements LicenseSpring.ICustomerService.

◆ CreateCustomer()

Customer LicenseSpring.CustomerService.CreateCustomer ( CreateCustomerDto  dto)

Creates a new customer.

Parameters
dtoCustomer dto with information about new customer.

Implements LicenseSpring.ICustomerService.

◆ CreateCustomerAccount()

CustomerAccount LicenseSpring.CustomerService.CreateCustomerAccount ( CustomerAccount  account)

Creates a customer account if requesting manager has access permissions to it.

Parameters
accountCustomer account to create. The Code field is required and must be unique.

Implements LicenseSpring.ICustomerService.

◆ CreateCustomerLabel()

CustomerLabel LicenseSpring.CustomerService.CreateCustomerLabel ( CustomerLabel  label)

Creates a customer label.

Parameters
labelLabel to create.

Implements LicenseSpring.ICustomerService.

◆ DeleteCustomer()

string LicenseSpring.CustomerService.DeleteCustomer ( ulong  customerId)

Deletes the customer.

Parameters
customerIdThe Id of the customer that will be deleted.

Implements LicenseSpring.ICustomerService.

◆ DeleteCustomerAccount()

void LicenseSpring.CustomerService.DeleteCustomerAccount ( CustomerAccount  account)

Deletes a customer account.

Parameters
accountCustomer account to delete. The Id field must be set.

Implements LicenseSpring.ICustomerService.

◆ DeleteCustomerLabel()

void LicenseSpring.CustomerService.DeleteCustomerLabel ( CustomerLabel  label)

Deletes a customer label.

Parameters
labelLabel to delete.

Implements LicenseSpring.ICustomerService.

◆ EditCustomer()

Customer LicenseSpring.CustomerService.EditCustomer ( Customer  customer)

Updates information about a customer.

Parameters
customerCustomer that was updated.

Implements LicenseSpring.ICustomerService.

◆ EditCustomerAccount()

CustomerAccount LicenseSpring.CustomerService.EditCustomerAccount ( CustomerAccount  account)

Updates a customer account if requesting manager has access permissions to it.

Parameters
accountCustomer account with updated fields. The Id field must be set; if the Code field is set, it must be unique.

Implements LicenseSpring.ICustomerService.

◆ EditCustomerLabel()

CustomerLabel LicenseSpring.CustomerService.EditCustomerLabel ( CustomerLabel  label)

Updates information about a customer label.

Parameters
labelLabel that was updated.

Implements LicenseSpring.ICustomerService.

◆ ListCustomerAccounts()

CustomerAccount[] LicenseSpring.CustomerService.ListCustomerAccounts ( BaseListDto  dto,
out uint  Count 
)

Shows all customer accounts the requesting manager has access permissions to.

Parameters
dtoData transfer object that is used for searching through all customer accounts.
countQuantity of customers, use for iteration of the result pages.

Implements LicenseSpring.ICustomerService.

◆ ListCustomerLabels()

CustomerLabel[] LicenseSpring.CustomerService.ListCustomerLabels ( BaseListDto  dto,
out uint  Count 
)

Returns all customer labels.

Parameters
dtoData transfer object that is used for searching through all customer labels.
countQuantity of customers, use for iteration of the result pages.

Implements LicenseSpring.ICustomerService.

◆ ListCustomers()

Customer[] LicenseSpring.CustomerService.ListCustomers ( ListCustomersRequestDto  dto,
out uint  Count 
)

Returns all customers.

Parameters
dtoData transfer object that is used for searching through all customers.
countQuantity of customers, use for iteration of the result pages.

Implements LicenseSpring.ICustomerService.

◆ MergeCustomers()

string LicenseSpring.CustomerService.MergeCustomers ( ulong  customerId,
ulong  customerToMergeId 
)

Merges once customer into another if requesting manager has access permissions to it.Updates customer on all orders from the customer to merge to the customer provided in the first parameter and deletes the customer to merge.

Implements LicenseSpring.ICustomerService.

◆ RemoveLabelFromCustomer()

void LicenseSpring.CustomerService.RemoveLabelFromCustomer ( CustomerLabel  label)

Removes a label from customer.

Parameters
labelLabel to be removed.

Implements LicenseSpring.ICustomerService.


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