/**
* Deletes the location specified in the request.
*
* <p>
*
* <pre><code>
* MozuClient mozuClient=DeleteLocationClient( locationCode);
* client.setBaseAddress(url);
* client.executeRequest();
* </code></pre>
*
* @param locationCode The unique, user-defined code that identifies a location.
* @return Mozu.Api.MozuClient
*/
public static MozuClient deleteLocationClient(String locationCode) throws Exception {
MozuUrl url = com.mozu.api.urls.commerce.admin.LocationUrl.deleteLocationUrl(locationCode);
String verb = "DELETE";
MozuClient mozuClient = (MozuClient) MozuClientFactory.getInstance();
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Deletes the authentication ticket for the user by supplying the refresh token.
*
* <p>
*
* <pre><code>
* MozuClient mozuClient=DeleteUserAuthTicketClient( refreshToken);
* client.setBaseAddress(url);
* client.executeRequest();
* </code></pre>
*
* @param refreshToken Alphanumeric string used for access tokens. This token refreshes access for
* accounts by generating a new developer or application account authentication ticket after
* an access token expires.
* @return Mozu.Api.MozuClient
*/
public static MozuClient deleteUserAuthTicketClient(String refreshToken) throws Exception {
MozuUrl url =
com.mozu.api.urls.platform.adminuser.TenantAdminUserAuthTicketUrl.deleteUserAuthTicketUrl(
refreshToken);
String verb = "DELETE";
MozuClient mozuClient = (MozuClient) MozuClientFactory.getInstance();
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Deletes a contact for the specified customer account.
*
* <p>
*
* <pre><code>
* MozuClient mozuClient=DeleteAccountContactClient( accountId, contactId);
* client.setBaseAddress(url);
* client.executeRequest();
* </code></pre>
*
* @param accountId Unique identifier of the customer account.
* @param contactId Unique identifer of the customer account contact being updated.
* @return Mozu.Api.MozuClient
*/
public static MozuClient deleteAccountContactClient(Integer accountId, Integer contactId)
throws Exception {
MozuUrl url =
com.mozu.api.urls.commerce.customer.accounts.CustomerContactUrl.deleteAccountContactUrl(
accountId, contactId);
String verb = "DELETE";
MozuClient mozuClient = (MozuClient) MozuClientFactory.getInstance();
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Removes an item from the wish list specified in the request.
*
* <p>
*
* <pre><code>
* MozuClient mozuClient=DeleteWishlistItemClient( wishlistId, wishlistItemId);
* client.setBaseAddress(url);
* client.executeRequest();
* </code></pre>
*
* @param wishlistId Unique identifier of the wish list.
* @param wishlistItemId Unique identifier of the item to remove from the shopper wish list.
* @return Mozu.Api.MozuClient
*/
public static MozuClient deleteWishlistItemClient(String wishlistId, String wishlistItemId)
throws Exception {
MozuUrl url =
com.mozu.api.urls.commerce.wishlists.WishlistItemUrl.deleteWishlistItemUrl(
wishlistId, wishlistItemId);
String verb = "DELETE";
MozuClient mozuClient = (MozuClient) MozuClientFactory.getInstance();
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Creates a new physical location for the tenant specified in the request header.
*
* <p>
*
* <pre><code>
* MozuClient<com.mozu.api.contracts.location.Location> mozuClient=AddLocationClient( location, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Location location = client.Result();
* </code></pre>
*
* @param responseFields A list or array of fields returned for a call. These fields may be
* customized and may be used for various types of data calls in Mozu. For example,
* responseFields are returned for retrieving or updating attributes, carts, and messages in
* Mozu.
* @param location Properties of a physical location a tenant uses to manage inventory and
* fulfills orders, provide store finder functionality, or both.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.location.Location>
* @see com.mozu.api.contracts.location.Location
* @see com.mozu.api.contracts.location.Location
*/
public static MozuClient<com.mozu.api.contracts.location.Location> addLocationClient(
com.mozu.api.contracts.location.Location location, String responseFields) throws Exception {
MozuUrl url = com.mozu.api.urls.commerce.admin.LocationUrl.addLocationUrl(responseFields);
String verb = "POST";
Class<?> clz = com.mozu.api.contracts.location.Location.class;
MozuClient<com.mozu.api.contracts.location.Location> mozuClient =
(MozuClient<com.mozu.api.contracts.location.Location>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(location);
return mozuClient;
}
/**
* Removes all items associated with a shopper wish list.
*
* <p>
*
* <pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.Wishlist> mozuClient=RemoveAllWishlistItemsClient( wishlistId);
* client.setBaseAddress(url);
* client.executeRequest();
* Wishlist wishlist = client.Result();
* </code></pre>
*
* @param wishlistId Unique identifier of the wish list.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.wishlists.Wishlist>
* @see com.mozu.api.contracts.commerceruntime.wishlists.Wishlist
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.Wishlist>
removeAllWishlistItemsClient(String wishlistId) throws Exception {
MozuUrl url =
com.mozu.api.urls.commerce.wishlists.WishlistItemUrl.removeAllWishlistItemsUrl(wishlistId);
String verb = "DELETE";
Class<?> clz = com.mozu.api.contracts.commerceruntime.wishlists.Wishlist.class;
MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.Wishlist> mozuClient =
(MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.Wishlist>)
MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Retrieves the specified contact for a customer account such as a billing or shipping contact.
*
* <p>
*
* <pre><code>
* MozuClient<com.mozu.api.contracts.customer.CustomerContact> mozuClient=GetAccountContactClient( accountId, contactId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* CustomerContact customerContact = client.Result();
* </code></pre>
*
* @param accountId Unique identifier of the customer account.
* @param contactId Unique identifer of the customer account contact being updated.
* @param responseFields Use this field to include those fields which are not included by default.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.CustomerContact>
* @see com.mozu.api.contracts.customer.CustomerContact
*/
public static MozuClient<com.mozu.api.contracts.customer.CustomerContact> getAccountContactClient(
Integer accountId, Integer contactId, String responseFields) throws Exception {
MozuUrl url =
com.mozu.api.urls.commerce.customer.accounts.CustomerContactUrl.getAccountContactUrl(
accountId, contactId, responseFields);
String verb = "GET";
Class<?> clz = com.mozu.api.contracts.customer.CustomerContact.class;
MozuClient<com.mozu.api.contracts.customer.CustomerContact> mozuClient =
(MozuClient<com.mozu.api.contracts.customer.CustomerContact>)
MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Retrieves a list of all locations associated with a tenant, according to any filter and sort
* criteria specified in the request.
*
* <p>
*
* <pre><code>
* MozuClient<com.mozu.api.contracts.location.LocationCollection> mozuClient=GetLocationsClient( startIndex, pageSize, sortBy, filter, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* LocationCollection locationCollection = client.Result();
* </code></pre>
*
* @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.location.LocationCollection>
* @see com.mozu.api.contracts.location.LocationCollection
*/
public static MozuClient<com.mozu.api.contracts.location.LocationCollection> getLocationsClient(
Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields)
throws Exception {
MozuUrl url =
com.mozu.api.urls.commerce.admin.LocationUrl.getLocationsUrl(
filter, pageSize, responseFields, sortBy, startIndex);
String verb = "GET";
Class<?> clz = com.mozu.api.contracts.location.LocationCollection.class;
MozuClient<com.mozu.api.contracts.location.LocationCollection> mozuClient =
(MozuClient<com.mozu.api.contracts.location.LocationCollection>)
MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Retrieves the details of an item in a shopper wish list.
*
* <p>
*
* <pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.WishlistItem> mozuClient=GetWishlistItemClient( wishlistId, wishlistItemId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* WishlistItem wishlistItem = client.Result();
* </code></pre>
*
* @param responseFields Use this field to include those fields which are not included by default.
* @param wishlistId Unique identifier of the wish list.
* @param wishlistItemId Unique identifier of the item to remove from the shopper wish list.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.wishlists.WishlistItem>
* @see com.mozu.api.contracts.commerceruntime.wishlists.WishlistItem
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.WishlistItem>
getWishlistItemClient(String wishlistId, String wishlistItemId, String responseFields)
throws Exception {
MozuUrl url =
com.mozu.api.urls.commerce.wishlists.WishlistItemUrl.getWishlistItemUrl(
responseFields, wishlistId, wishlistItemId);
String verb = "GET";
Class<?> clz = com.mozu.api.contracts.commerceruntime.wishlists.WishlistItem.class;
MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.WishlistItem> mozuClient =
(MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.WishlistItem>)
MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Validates the customer address supplied in the request.
*
* <p>
*
* <pre><code>
* MozuClient<com.mozu.api.contracts.customer.AddressValidationResponse> mozuClient=ValidateAddressClient( addressValidationRequest, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* AddressValidationResponse addressValidationResponse = client.Result();
* </code></pre>
*
* @param responseFields Use this field to include those fields which are not included by default.
* @param addressValidationRequest Properties of the address used for validation of the account's
* full address. This content may include multiple lines of an address, city, state/province,
* zip/postal code, and country.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.customer.AddressValidationResponse>
* @see com.mozu.api.contracts.customer.AddressValidationResponse
* @see com.mozu.api.contracts.customer.AddressValidationRequest
*/
public static MozuClient<com.mozu.api.contracts.customer.AddressValidationResponse>
validateAddressClient(
com.mozu.api.contracts.customer.AddressValidationRequest addressValidationRequest,
String responseFields)
throws Exception {
MozuUrl url =
com.mozu.api.urls.commerce.customer.AddressValidationRequestUrl.validateAddressUrl(
responseFields);
String verb = "POST";
Class<?> clz = com.mozu.api.contracts.customer.AddressValidationResponse.class;
MozuClient<com.mozu.api.contracts.customer.AddressValidationResponse> mozuClient =
(MozuClient<com.mozu.api.contracts.customer.AddressValidationResponse>)
MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(addressValidationRequest);
return mozuClient;
}
/**
* Add a new order validation result to a submitted order.
*
* <p>
*
* <pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderValidationResult> mozuClient=AddValidationResultClient( validationResult, orderId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* OrderValidationResult orderValidationResult = client.Result();
* </code></pre>
*
* @param orderId Unique identifier of the order.
* @param responseFields Use this field to include those fields which are not included by default.
* @param validationResult Properties of the resulting order validation performed by an order
* validation capability.
* @return Mozu.Api.MozuClient
* <com.mozu.api.contracts.commerceruntime.orders.OrderValidationResult>
* @see com.mozu.api.contracts.commerceruntime.orders.OrderValidationResult
* @see com.mozu.api.contracts.commerceruntime.orders.OrderValidationResult
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderValidationResult>
addValidationResultClient(
com.mozu.api.contracts.commerceruntime.orders.OrderValidationResult validationResult,
String orderId,
String responseFields)
throws Exception {
MozuUrl url =
com.mozu.api.urls.commerce.orders.OrderValidationResultUrl.addValidationResultUrl(
orderId, responseFields);
String verb = "PUT";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.OrderValidationResult.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderValidationResult> mozuClient =
(MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderValidationResult>)
MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(validationResult);
return mozuClient;
}
/**
* Creates an authentication ticket for the supplied user to specify in API requests associated
* with the supplied tenant.
*
* <p>
*
* <pre><code>
* MozuClient<com.mozu.api.contracts.adminuser.TenantAdminUserAuthTicket> mozuClient=CreateUserAuthTicketClient( userAuthInfo, tenantId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* TenantAdminUserAuthTicket tenantAdminUserAuthTicket = client.Result();
* </code></pre>
*
* @param responseFields Use this field to include those fields which are not included by default.
* @param tenantId Unique identifier of the development or production tenant for which to generate
* the user authentication ticket.
* @param userAuthInfo Information required to authenticate a user.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.adminuser.TenantAdminUserAuthTicket>
* @see com.mozu.api.contracts.adminuser.TenantAdminUserAuthTicket
* @see com.mozu.api.contracts.core.UserAuthInfo
*/
public static MozuClient<com.mozu.api.contracts.adminuser.TenantAdminUserAuthTicket>
createUserAuthTicketClient(
com.mozu.api.contracts.core.UserAuthInfo userAuthInfo,
Integer tenantId,
String responseFields)
throws Exception {
MozuUrl url =
com.mozu.api.urls.platform.adminuser.TenantAdminUserAuthTicketUrl.createUserAuthTicketUrl(
responseFields, tenantId);
String verb = "POST";
Class<?> clz = com.mozu.api.contracts.adminuser.TenantAdminUserAuthTicket.class;
MozuClient<com.mozu.api.contracts.adminuser.TenantAdminUserAuthTicket> mozuClient =
(MozuClient<com.mozu.api.contracts.adminuser.TenantAdminUserAuthTicket>)
MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(userAuthInfo);
return mozuClient;
}
/**
* Retrieves a list of items in a shopper wish list according to any specified filter and sort
* criteria.
*
* <p>
*
* <pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.WishlistItemCollection> mozuClient=GetWishlistItemsClient( wishlistId, startIndex, pageSize, sortBy, filter, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* WishlistItemCollection wishlistItemCollection = client.Result();
* </code></pre>
*
* @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.
* @param wishlistId Unique identifier of the wish list.
* @return Mozu.Api.MozuClient
* <com.mozu.api.contracts.commerceruntime.wishlists.WishlistItemCollection>
* @see com.mozu.api.contracts.commerceruntime.wishlists.WishlistItemCollection
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.WishlistItemCollection>
getWishlistItemsClient(
String wishlistId,
Integer startIndex,
Integer pageSize,
String sortBy,
String filter,
String responseFields)
throws Exception {
MozuUrl url =
com.mozu.api.urls.commerce.wishlists.WishlistItemUrl.getWishlistItemsUrl(
filter, pageSize, responseFields, sortBy, startIndex, wishlistId);
String verb = "GET";
Class<?> clz = com.mozu.api.contracts.commerceruntime.wishlists.WishlistItemCollection.class;
MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.WishlistItemCollection> mozuClient =
(MozuClient<com.mozu.api.contracts.commerceruntime.wishlists.WishlistItemCollection>)
MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}