/**
* This code was auto-generated by a Codezu.
*
* Changes to this file may cause incorrect behavior and will be lost if
* the code is regenerated.
*/
package com.mozu.api.clients.commerce.customer.accounts;
import java.util.List;
import java.util.ArrayList;
import com.mozu.api.MozuClient;
import com.mozu.api.MozuClientFactory;
import com.mozu.api.MozuUrl;
import com.mozu.api.Headers;
import org.joda.time.DateTime;
import com.mozu.api.AsyncCallback;
import java.util.concurrent.CountDownLatch;
import com.mozu.api.security.AuthTicket;
import org.apache.commons.lang.StringUtils;
/** <summary>
* Tenant administrators can add and view internal notes for a customer account. For example, a client can track a shopper's interests or complaints. Only clients can add and view notes. Shoppers cannot view these notes from the My Account page.
* </summary>
*/
public class CustomerNoteClient {
/**
* Retrieves the contents of a particular note attached to a specified customer account.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.customer.CustomerNote> mozuClient=GetAccountNoteClient( accountId, noteId);
* client.setBaseAddress(url);
* client.executeRequest();
* CustomerNote customerNote = client.Result();
* </code></pre></p>
* @param accountId Unique identifier of the customer account.
* @param noteId Unique identifier of a particular note to retrieve.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.CustomerNote>
* @see com.mozu.api.contracts.customer.CustomerNote
*/
public static MozuClient<com.mozu.api.contracts.customer.CustomerNote> getAccountNoteClient(Integer accountId, Integer noteId) throws Exception
{
return getAccountNoteClient( accountId, noteId, null);
}
/**
* Retrieves the contents of a particular note attached to a specified customer account.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.customer.CustomerNote> mozuClient=GetAccountNoteClient( accountId, noteId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* CustomerNote customerNote = client.Result();
* </code></pre></p>
* @param accountId Unique identifier of the customer account.
* @param noteId Unique identifier of a particular note to retrieve.
* @param responseFields Use this field to include those fields which are not included by default.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.CustomerNote>
* @see com.mozu.api.contracts.customer.CustomerNote
*/
public static MozuClient<com.mozu.api.contracts.customer.CustomerNote> getAccountNoteClient(Integer accountId, Integer noteId, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.customer.accounts.CustomerNoteUrl.getAccountNoteUrl(accountId, noteId, responseFields);
String verb = "GET";
Class<?> clz = com.mozu.api.contracts.customer.CustomerNote.class;
MozuClient<com.mozu.api.contracts.customer.CustomerNote> mozuClient = (MozuClient<com.mozu.api.contracts.customer.CustomerNote>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Retrieves a list of notes added to a customer account according to any specified filter criteria and sort options.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.customer.CustomerNoteCollection> mozuClient=GetAccountNotesClient( accountId);
* client.setBaseAddress(url);
* client.executeRequest();
* CustomerNoteCollection customerNoteCollection = client.Result();
* </code></pre></p>
* @param accountId Unique identifier of the customer account.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.CustomerNoteCollection>
* @see com.mozu.api.contracts.customer.CustomerNoteCollection
*/
public static MozuClient<com.mozu.api.contracts.customer.CustomerNoteCollection> getAccountNotesClient(Integer accountId) throws Exception
{
return getAccountNotesClient( accountId, null, null, null, null, null);
}
/**
* Retrieves a list of notes added to a customer account according to any specified filter criteria and sort options.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.customer.CustomerNoteCollection> mozuClient=GetAccountNotesClient( accountId, startIndex, pageSize, sortBy, filter, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* CustomerNoteCollection customerNoteCollection = client.Result();
* </code></pre></p>
* @param accountId Unique identifier of the customer account.
* @param filter A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. Valid operators include equals (eq), does not equal (ne), greater than (gt), less than (lt), greater than or equal to (ge), less than or equal to (le), starts with (sw), or contains (cont). For example - "filter=IsDisplayed+eq+true"
* @param pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200.
* @param responseFields Use this field to include those fields which are not included by default.
* @param sortBy The property by which to sort results and whether the results appear in ascending (a-z) order, represented by ASC or in descending (z-a) order, represented by DESC. The sortBy parameter follows an available property. For example: "sortBy=productCode+asc"
* @param startIndex When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, use startIndex=3.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.CustomerNoteCollection>
* @see com.mozu.api.contracts.customer.CustomerNoteCollection
*/
public static MozuClient<com.mozu.api.contracts.customer.CustomerNoteCollection> getAccountNotesClient(Integer accountId, Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.customer.accounts.CustomerNoteUrl.getAccountNotesUrl(accountId, filter, pageSize, responseFields, sortBy, startIndex);
String verb = "GET";
Class<?> clz = com.mozu.api.contracts.customer.CustomerNoteCollection.class;
MozuClient<com.mozu.api.contracts.customer.CustomerNoteCollection> mozuClient = (MozuClient<com.mozu.api.contracts.customer.CustomerNoteCollection>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Adds a new note to the specified customer account.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.customer.CustomerNote> mozuClient=AddAccountNoteClient( note, accountId);
* client.setBaseAddress(url);
* client.executeRequest();
* CustomerNote customerNote = client.Result();
* </code></pre></p>
* @param accountId Unique identifier of the customer account.
* @param note Properties of a note configured for a customer account.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.CustomerNote>
* @see com.mozu.api.contracts.customer.CustomerNote
* @see com.mozu.api.contracts.customer.CustomerNote
*/
public static MozuClient<com.mozu.api.contracts.customer.CustomerNote> addAccountNoteClient(com.mozu.api.contracts.customer.CustomerNote note, Integer accountId) throws Exception
{
return addAccountNoteClient( note, accountId, null);
}
/**
* Adds a new note to the specified customer account.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.customer.CustomerNote> mozuClient=AddAccountNoteClient( note, accountId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* CustomerNote customerNote = client.Result();
* </code></pre></p>
* @param accountId Unique identifier of the customer account.
* @param responseFields Use this field to include those fields which are not included by default.
* @param note Properties of a note configured for a customer account.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.CustomerNote>
* @see com.mozu.api.contracts.customer.CustomerNote
* @see com.mozu.api.contracts.customer.CustomerNote
*/
public static MozuClient<com.mozu.api.contracts.customer.CustomerNote> addAccountNoteClient(com.mozu.api.contracts.customer.CustomerNote note, Integer accountId, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.customer.accounts.CustomerNoteUrl.addAccountNoteUrl(accountId, responseFields);
String verb = "POST";
Class<?> clz = com.mozu.api.contracts.customer.CustomerNote.class;
MozuClient<com.mozu.api.contracts.customer.CustomerNote> mozuClient = (MozuClient<com.mozu.api.contracts.customer.CustomerNote>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(note);
return mozuClient;
}
/**
* Modifies an existing note for a customer account.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.customer.CustomerNote> mozuClient=UpdateAccountNoteClient( note, accountId, noteId);
* client.setBaseAddress(url);
* client.executeRequest();
* CustomerNote customerNote = client.Result();
* </code></pre></p>
* @param accountId Unique identifier of the customer account.
* @param noteId Unique identifier of a particular note to retrieve.
* @param note Properties of a note configured for a customer account.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.CustomerNote>
* @see com.mozu.api.contracts.customer.CustomerNote
* @see com.mozu.api.contracts.customer.CustomerNote
*/
public static MozuClient<com.mozu.api.contracts.customer.CustomerNote> updateAccountNoteClient(com.mozu.api.contracts.customer.CustomerNote note, Integer accountId, Integer noteId) throws Exception
{
return updateAccountNoteClient( note, accountId, noteId, null);
}
/**
* Modifies an existing note for a customer account.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.customer.CustomerNote> mozuClient=UpdateAccountNoteClient( note, accountId, noteId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* CustomerNote customerNote = client.Result();
* </code></pre></p>
* @param accountId Unique identifier of the customer account.
* @param noteId Unique identifier of a particular note to retrieve.
* @param responseFields Use this field to include those fields which are not included by default.
* @param note Properties of a note configured for a customer account.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.CustomerNote>
* @see com.mozu.api.contracts.customer.CustomerNote
* @see com.mozu.api.contracts.customer.CustomerNote
*/
public static MozuClient<com.mozu.api.contracts.customer.CustomerNote> updateAccountNoteClient(com.mozu.api.contracts.customer.CustomerNote note, Integer accountId, Integer noteId, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.customer.accounts.CustomerNoteUrl.updateAccountNoteUrl(accountId, noteId, responseFields);
String verb = "PUT";
Class<?> clz = com.mozu.api.contracts.customer.CustomerNote.class;
MozuClient<com.mozu.api.contracts.customer.CustomerNote> mozuClient = (MozuClient<com.mozu.api.contracts.customer.CustomerNote>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(note);
return mozuClient;
}
/**
* Removes a note from the specified customer account.
* <p><pre><code>
* MozuClient mozuClient=DeleteAccountNoteClient( accountId, noteId);
* client.setBaseAddress(url);
* client.executeRequest();
* </code></pre></p>
* @param accountId Unique identifier of the customer account.
* @param noteId Unique identifier of a particular note to retrieve.
* @return Mozu.Api.MozuClient
*/
public static MozuClient deleteAccountNoteClient(Integer accountId, Integer noteId) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.customer.accounts.CustomerNoteUrl.deleteAccountNoteUrl(accountId, noteId);
String verb = "DELETE";
MozuClient mozuClient = (MozuClient) MozuClientFactory.getInstance();
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
}