C# Class VirtoCommerce.SwaggerApiClient.Api.CustomerManagementModuleApi

Represents a collection of functions to interact with the API endpoints

Inheritance: ICustomerManagementModuleApi

Datei anzeigen Open project: VirtoCommerce/vc-internal

Public Methods

Method	Description
CustomerManagementModuleApi ( ApiClient apiClient = null ) : System	Initializes a new instance of the CustomerManagementModuleApi class.
CustomerManagementModuleApi ( String basePath ) : System	Initializes a new instance of the CustomerManagementModuleApi class.
CustomerModuleCreateContact ( VirtoCommerceCustomerModuleWebModelContact contact ) : VirtoCommerceCustomerModuleWebModelContact	Create contact
CustomerModuleCreateContactAsync ( VirtoCommerceCustomerModuleWebModelContact contact ) : System.Threading.Tasks.Task	Create contact
CustomerModuleCreateOrganization ( VirtoCommerceCustomerModuleWebModelOrganization organization ) : VirtoCommerceCustomerModuleWebModelOrganization	Create organization
CustomerModuleCreateOrganizationAsync ( VirtoCommerceCustomerModuleWebModelOrganization organization ) : System.Threading.Tasks.Task	Create organization
CustomerModuleDeleteContacts ( List ids ) : void	Delete contacts Delete contacts by given array of ids.
CustomerModuleDeleteContactsAsync ( List ids ) : System.Threading.Tasks.Task	Delete contacts Delete contacts by given array of ids.
CustomerModuleDeleteOrganizations ( List ids ) : void	Delete organizations Delete organizations by given array of ids.
CustomerModuleDeleteOrganizationsAsync ( List ids ) : System.Threading.Tasks.Task	Delete organizations Delete organizations by given array of ids.
CustomerModuleGetContactById ( string id ) : void	Get contact
CustomerModuleGetContactByIdAsync ( string id ) : System.Threading.Tasks.Task	Get contact
CustomerModuleGetOrganizationById ( string id ) : void	Get organization
CustomerModuleGetOrganizationByIdAsync ( string id ) : System.Threading.Tasks.Task	Get organization
CustomerModuleListOrganizations ( ) : List	Get organizations Get array of all organizations.
CustomerModuleListOrganizationsAsync ( ) : System.Threading.Tasks.Task>	Get organizations Get array of all organizations.
CustomerModuleSearch ( string criteriaKeyword, string criteriaOrganizationId, int criteriaStart, int criteriaCount ) : VirtoCommerceCustomerModuleWebModelSearchResult	Get members Get array of members satisfied search criteria.
CustomerModuleSearchAsync ( string criteriaKeyword, string criteriaOrganizationId, int criteriaStart, int criteriaCount ) : System.Threading.Tasks.Task	Get members Get array of members satisfied search criteria.
CustomerModuleUpdateContact ( VirtoCommerceCustomerModuleWebModelContact contact ) : void	Update contact
CustomerModuleUpdateContactAsync ( VirtoCommerceCustomerModuleWebModelContact contact ) : System.Threading.Tasks.Task	Update contact
CustomerModuleUpdateOrganization ( VirtoCommerceCustomerModuleWebModelOrganization organization ) : void	Update organization
CustomerModuleUpdateOrganizationAsync ( VirtoCommerceCustomerModuleWebModelOrganization organization ) : System.Threading.Tasks.Task	Update organization
GetBasePath ( ) : String	Gets the base path of the API client.
SetBasePath ( String basePath ) : void	Sets the base path of the API client.

Method Details

CustomerManagementModuleApi() public method

Initializes a new instance of the CustomerManagementModuleApi class.

public CustomerManagementModuleApi ( ApiClient apiClient = null ) : System
apiClient	VirtoCommerce.SwaggerApiClient.Client.ApiClient	an instance of ApiClient (optional)
return	System

CustomerManagementModuleApi() public method

Initializes a new instance of the CustomerManagementModuleApi class.

public CustomerManagementModuleApi ( String basePath ) : System
basePath	String
return	System

CustomerModuleCreateContact() public method

Create contact

public CustomerModuleCreateContact ( VirtoCommerceCustomerModuleWebModelContact contact ) : VirtoCommerceCustomerModuleWebModelContact
contact	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceCustomerModuleWebModelContact
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceCustomerModuleWebModelContact

CustomerModuleCreateContactAsync() public method

Create contact

public CustomerModuleCreateContactAsync ( VirtoCommerceCustomerModuleWebModelContact contact ) : System.Threading.Tasks.Task
contact	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceCustomerModuleWebModelContact
return	System.Threading.Tasks.Task

CustomerModuleCreateOrganization() public method

Create organization

public CustomerModuleCreateOrganization ( VirtoCommerceCustomerModuleWebModelOrganization organization ) : VirtoCommerceCustomerModuleWebModelOrganization
organization	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceCustomerModuleWebModelOrganization
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceCustomerModuleWebModelOrganization

CustomerModuleCreateOrganizationAsync() public method

Create organization

public CustomerModuleCreateOrganizationAsync ( VirtoCommerceCustomerModuleWebModelOrganization organization ) : System.Threading.Tasks.Task
organization	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceCustomerModuleWebModelOrganization
return	System.Threading.Tasks.Task

CustomerModuleDeleteContacts() public method

Delete contacts Delete contacts by given array of ids.

public CustomerModuleDeleteContacts ( List ids ) : void
ids	List	An array of contacts ids
return	void

CustomerModuleDeleteContactsAsync() public method

Delete contacts Delete contacts by given array of ids.

public CustomerModuleDeleteContactsAsync ( List ids ) : System.Threading.Tasks.Task
ids	List	An array of contacts ids
return	System.Threading.Tasks.Task

CustomerModuleDeleteOrganizations() public method

Delete organizations Delete organizations by given array of ids.

public CustomerModuleDeleteOrganizations ( List ids ) : void
ids	List	An array of organizations ids
return	void

CustomerModuleDeleteOrganizationsAsync() public method

Delete organizations Delete organizations by given array of ids.

public CustomerModuleDeleteOrganizationsAsync ( List ids ) : System.Threading.Tasks.Task
ids	List	An array of organizations ids
return	System.Threading.Tasks.Task

CustomerModuleGetContactById() public method

Get contact

public CustomerModuleGetContactById ( string id ) : void
id	string	Contact id
return	void

CustomerModuleGetContactByIdAsync() public method

Get contact

public CustomerModuleGetContactByIdAsync ( string id ) : System.Threading.Tasks.Task
id	string	Contact id
return	System.Threading.Tasks.Task

CustomerModuleGetOrganizationById() public method

Get organization

public CustomerModuleGetOrganizationById ( string id ) : void
id	string	Organization id
return	void

CustomerModuleGetOrganizationByIdAsync() public method

Get organization

public CustomerModuleGetOrganizationByIdAsync ( string id ) : System.Threading.Tasks.Task
id	string	Organization id
return	System.Threading.Tasks.Task

CustomerModuleListOrganizations() public method

Get organizations Get array of all organizations.

public CustomerModuleListOrganizations ( ) : List
return	List

CustomerModuleListOrganizationsAsync() public method

Get organizations Get array of all organizations.

public CustomerModuleListOrganizationsAsync ( ) : System.Threading.Tasks.Task>
return	System.Threading.Tasks.Task>

CustomerModuleSearch() public method

Get members Get array of members satisfied search criteria.

public CustomerModuleSearch ( string criteriaKeyword, string criteriaOrganizationId, int criteriaStart, int criteriaCount ) : VirtoCommerceCustomerModuleWebModelSearchResult
criteriaKeyword	string	Word, part of word or phrase to search
criteriaOrganizationId	string	It used to limit search within an organization
criteriaStart	int	It used to skip some first search results
criteriaCount	int	It used to limit the number of search results
return	VirtoCommerceCustomerModuleWebModelSearchResult

CustomerModuleSearchAsync() public method

Get members Get array of members satisfied search criteria.

public CustomerModuleSearchAsync ( string criteriaKeyword, string criteriaOrganizationId, int criteriaStart, int criteriaCount ) : System.Threading.Tasks.Task
criteriaKeyword	string	Word, part of word or phrase to search
criteriaOrganizationId	string	It used to limit search within an organization
criteriaStart	int	It used to skip some first search results
criteriaCount	int	It used to limit the number of search results
return	System.Threading.Tasks.Task

CustomerModuleUpdateContact() public method

Update contact

public CustomerModuleUpdateContact ( VirtoCommerceCustomerModuleWebModelContact contact ) : void
contact	VirtoCommerceCustomerModuleWebModelContact
return	void

CustomerModuleUpdateContactAsync() public method

Update contact

public CustomerModuleUpdateContactAsync ( VirtoCommerceCustomerModuleWebModelContact contact ) : System.Threading.Tasks.Task
contact	VirtoCommerceCustomerModuleWebModelContact
return	System.Threading.Tasks.Task

CustomerModuleUpdateOrganization() public method

Update organization

public CustomerModuleUpdateOrganization ( VirtoCommerceCustomerModuleWebModelOrganization organization ) : void
organization	VirtoCommerceCustomerModuleWebModelOrganization
return	void

CustomerModuleUpdateOrganizationAsync() public method

Update organization

public CustomerModuleUpdateOrganizationAsync ( VirtoCommerceCustomerModuleWebModelOrganization organization ) : System.Threading.Tasks.Task
organization	VirtoCommerceCustomerModuleWebModelOrganization
return	System.Threading.Tasks.Task

GetBasePath() public method

Gets the base path of the API client.

public GetBasePath ( ) : String
return	String

SetBasePath() public method

Sets the base path of the API client.

public SetBasePath ( String basePath ) : void
basePath	String	The base path
return	void