/**
* 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.resources.commerce.shipping.admin;
import com.mozu.api.ApiContext;
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.security.AuthTicket;
import org.apache.commons.lang.StringUtils;
/** <summary>
* Use the Carriers resource to configure and manage your supported shipping carrier configurations.
* </summary>
*/
public class CarrierConfigurationResource {
///
/// <see cref="Mozu.Api.ApiContext"/>
///
private ApiContext _apiContext;
public CarrierConfigurationResource(ApiContext apiContext)
{
_apiContext = apiContext;
}
/**
* Retrieves a list of carrier configurations and their details according to any specified facets, filter criteria, and sort options.
* <p><pre><code>
* CarrierConfiguration carrierconfiguration = new CarrierConfiguration();
* CarrierConfigurationCollection carrierConfigurationCollection = carrierconfiguration.getConfigurations();
* </code></pre></p>
* @return com.mozu.api.contracts.shippingadmin.CarrierConfigurationCollection
* @see com.mozu.api.contracts.shippingadmin.CarrierConfigurationCollection
*/
public com.mozu.api.contracts.shippingadmin.CarrierConfigurationCollection getConfigurations() throws Exception
{
return getConfigurations( null, null, null, null, null);
}
/**
* Retrieves a list of carrier configurations and their details according to any specified facets, filter criteria, and sort options.
* <p><pre><code>
* CarrierConfiguration carrierconfiguration = new CarrierConfiguration();
* CarrierConfigurationCollection carrierConfigurationCollection = carrierconfiguration.getConfigurations( startIndex, pageSize, sortBy, filter, responseFields);
* </code></pre></p>
* @param filter A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters.
* @param pageSize 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50.
* @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
* @param sortBy The element to sort the results by and the channel in which the results appear. Either ascending (a-z) or descending (z-a) channel. Optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information.
* @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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50.
* @return com.mozu.api.contracts.shippingadmin.CarrierConfigurationCollection
* @see com.mozu.api.contracts.shippingadmin.CarrierConfigurationCollection
*/
public com.mozu.api.contracts.shippingadmin.CarrierConfigurationCollection getConfigurations(Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.shippingadmin.CarrierConfigurationCollection> client = com.mozu.api.clients.commerce.shipping.admin.CarrierConfigurationClient.getConfigurationsClient( startIndex, pageSize, sortBy, filter, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieves the details of the specified carrier configuration.
* <p><pre><code>
* CarrierConfiguration carrierconfiguration = new CarrierConfiguration();
* CarrierConfiguration carrierConfiguration = carrierconfiguration.getConfiguration( carrierId);
* </code></pre></p>
* @param carrierId The unique identifier of the carrier.
* @return com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
*/
public com.mozu.api.contracts.shippingadmin.CarrierConfiguration getConfiguration(String carrierId) throws Exception
{
return getConfiguration( carrierId, null);
}
/**
* Retrieves the details of the specified carrier configuration.
* <p><pre><code>
* CarrierConfiguration carrierconfiguration = new CarrierConfiguration();
* CarrierConfiguration carrierConfiguration = carrierconfiguration.getConfiguration( carrierId, responseFields);
* </code></pre></p>
* @param carrierId The unique identifier of the carrier.
* @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
* @return com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
*/
public com.mozu.api.contracts.shippingadmin.CarrierConfiguration getConfiguration(String carrierId, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.shippingadmin.CarrierConfiguration> client = com.mozu.api.clients.commerce.shipping.admin.CarrierConfigurationClient.getConfigurationClient( carrierId, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Creates a new carrier configuration.
* <p><pre><code>
* CarrierConfiguration carrierconfiguration = new CarrierConfiguration();
* CarrierConfiguration carrierConfiguration = carrierconfiguration.createConfiguration( carrierConfiguration, carrierId);
* </code></pre></p>
* @param carrierId The unique identifier of the carrier.
* @param carrierConfiguration Properties of a carrier configured in the shipping admin.
* @return com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
*/
public com.mozu.api.contracts.shippingadmin.CarrierConfiguration createConfiguration(com.mozu.api.contracts.shippingadmin.CarrierConfiguration carrierConfiguration, String carrierId) throws Exception
{
return createConfiguration( carrierConfiguration, carrierId, null);
}
/**
* Creates a new carrier configuration.
* <p><pre><code>
* CarrierConfiguration carrierconfiguration = new CarrierConfiguration();
* CarrierConfiguration carrierConfiguration = carrierconfiguration.createConfiguration( carrierConfiguration, carrierId, responseFields);
* </code></pre></p>
* @param carrierId The unique identifier of the carrier.
* @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
* @param carrierConfiguration Properties of a carrier configured in the shipping admin.
* @return com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
*/
public com.mozu.api.contracts.shippingadmin.CarrierConfiguration createConfiguration(com.mozu.api.contracts.shippingadmin.CarrierConfiguration carrierConfiguration, String carrierId, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.shippingadmin.CarrierConfiguration> client = com.mozu.api.clients.commerce.shipping.admin.CarrierConfigurationClient.createConfigurationClient( carrierConfiguration, carrierId, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Updates the details of the specified carrier configuration.
* <p><pre><code>
* CarrierConfiguration carrierconfiguration = new CarrierConfiguration();
* CarrierConfiguration carrierConfiguration = carrierconfiguration.updateConfiguration( carrierConfiguration, carrierId);
* </code></pre></p>
* @param carrierId The unique identifier of the carrier.
* @param carrierConfiguration Properties of a carrier configured in the shipping admin.
* @return com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
*/
public com.mozu.api.contracts.shippingadmin.CarrierConfiguration updateConfiguration(com.mozu.api.contracts.shippingadmin.CarrierConfiguration carrierConfiguration, String carrierId) throws Exception
{
return updateConfiguration( carrierConfiguration, carrierId, null);
}
/**
* Updates the details of the specified carrier configuration.
* <p><pre><code>
* CarrierConfiguration carrierconfiguration = new CarrierConfiguration();
* CarrierConfiguration carrierConfiguration = carrierconfiguration.updateConfiguration( carrierConfiguration, carrierId, responseFields);
* </code></pre></p>
* @param carrierId The unique identifier of the carrier.
* @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
* @param carrierConfiguration Properties of a carrier configured in the shipping admin.
* @return com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
* @see com.mozu.api.contracts.shippingadmin.CarrierConfiguration
*/
public com.mozu.api.contracts.shippingadmin.CarrierConfiguration updateConfiguration(com.mozu.api.contracts.shippingadmin.CarrierConfiguration carrierConfiguration, String carrierId, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.shippingadmin.CarrierConfiguration> client = com.mozu.api.clients.commerce.shipping.admin.CarrierConfigurationClient.updateConfigurationClient( carrierConfiguration, carrierId, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Deletes the specified carrier configuration.
* <p><pre><code>
* CarrierConfiguration carrierconfiguration = new CarrierConfiguration();
* carrierconfiguration.deleteConfiguration( carrierId);
* </code></pre></p>
* @param carrierId The unique identifier of the carrier configuration.
* @return
*/
public void deleteConfiguration(String carrierId) throws Exception
{
MozuClient client = com.mozu.api.clients.commerce.shipping.admin.CarrierConfigurationClient.deleteConfigurationClient( carrierId);
client.setContext(_apiContext);
client.executeRequest();
client.cleanupHttpConnection();
}
}