com.ebay.sdk.call.SetUserPreferencesCall Maven / Gradle / Ivy
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import java.lang.Boolean;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the SetUserPreferences call of eBay SOAP API.
*
* Title: SOAP API wrapper library.
* Description: Contains wrapper classes for eBay SOAP APIs.
* Copyright: Copyright (c) 2009
* Company: eBay Inc.
*
Input property: BidderNoticePreferences - This container is included if the seller wishes to receive contact information for unsuccessful bidders. This preference is only applicable for auction listings.
*
Input property: CombinedPaymentPreferences - This container is included if the seller wishes to set the preference for allowing Combined Invoice orders for cases where the buyer has multiple unpaid order line items from the same seller.
*
Input property: CrossPromotionPreferences - This container is deprecated.
*
Input property: SellerPaymentPreferences - This container is included if the seller wishes to set various payment preferences. One or more preferences may be set or modified under this container. Payment preferences specified in a SetUserPreferences call override the settings in My eBay payment preferences.
*
Input property: SellerFavoriteItemPreferences - This container is included if the seller wishes to set preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. One or more preferences may be set or modified under this container.
*
Input property: EndOfAuctionEmailPreferences - This container is included if the seller wishes to set preferences for the end-of-auction email sent to the winning bidder. These preferences allow the seller to customize the Email that is sent to buyer at the end of the auction. One or more preferences may be set or modified under this container. These preferences are only applicable for auction listings.
*
Input property: EmailShipmentTrackingNumberPreference - This field is included and set to true if the seller wishes to email the shipment's tracking number to the buyer.
*
Input property: RequiredShipPhoneNumberPreference - This field is included and set to true if the seller wishes to require the buyer to provide a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number.
*
Input property: UnpaidItemAssistancePreferences - This container is included if the seller wishes to set Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item case on the behalf of the seller if the buyer has not paid for the order after a specified number of days. One or more preferences may be set or modified under this container.
*
Input property: PurchaseReminderEmailPreferences - This container is included if the seller wishes to set the preference for sending a purchase reminder email to buyers.
*
Input property: SellerThirdPartyCheckoutDisabled - This field is no longer applicable, as third-party checkout on eBay is no longer possible.
*
Input property: DispatchCutoffTimePreference - This container is included if the seller wishes to set the order cut off time for same-day shipping. If the seller specifies a value of 0 in Item.DispatchTimeMax to offer same day handling when listing an item, the seller's shipping time commitment depends on the order cut off time set for the listing site, as indicated by the DispatchCutoffTimePreference.CutoffTime field.
*
*
* Note: This field is not applicable for sellers who have opted into the Handling Time Option of eBay Guaranteed Delivery, as this field only shows a single order cutoff time, but with the Handling Time Option, a seller can set a different order cutoff time for each business day. Currently, eBay Guaranteed Delivery is only available in the US.
*
Input property: GlobalShippingProgramListingPreference - If this flag is included and set to true, the seller's new listings will enable the Global Shipping Program by default.
*
*
* Note: This field is ignored for sellers who are not opted in to the Global Shipping Program (when GetUserPreferences returns OfferGlobalShippingProgramPreference with a value of false).
*
*
Input property: OverrideGSPserviceWithIntlService - If this flag is included and set to true, and the seller specifies an international shipping service to a particular country for a given listing, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program. The Global Shipping Program will still be the listing's default option for shipping to any Global Shipping-eligible country for which the seller does not specify an international shipping service.
*
* If this flag is set to false, the Global Shipping Program will be each Global Shipping-eligible listing's default option for shipping to any Global Shipping-eligible country, regardless of any international shipping service that the seller specifies for the listing.
*
Input property: OutOfStockControlPreference - If this flag is included and set to true, it enables the Out-of-Stock feature. A seller would use this feature to keep Fixed-Price GTC (Good 'Til Canceled) listings alive even when the "quantity available" value goes to 0 (zero). This is useful when waiting for additional stock and eliminates the need to end the listing and then recreating it when stock arrives.
* While the "quantity available" value is 0, the listing would be hidden from eBay search and if that item was specifically searched for with GetItem (or related call), the element HideFromSearch would be returned as 'true' and ReasonHideFromSearch would be returned as 'OutOfStock'.
*
* When stock is available, the seller can use the Revise calls to update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields) and the listing would appear again.
*
* You can return the value of this flag using the GetUserPreferences call and setting the ShowOutOfStockControlPreference field to 'true'.
* IMPORTANT: When a listing using the Out-of-Stock feature has zero quantity, the seller has 90 days to add inventory without incurring a listing fee. Fees are changed at the end of each the billing cycle but are then refunded if the item is out-of-stock for an entire billing period. See Fees For a Listing With Zero Quantity for details.
*
* @author Ron Murphy
* @version 1.0
*/
public class SetUserPreferencesCall extends com.ebay.sdk.ApiCall
{
private BidderNoticePreferencesType bidderNoticePreferences = null;
private CombinedPaymentPreferencesType combinedPaymentPreferences = null;
private CrossPromotionPreferencesType crossPromotionPreferences = null;
private SellerPaymentPreferencesType sellerPaymentPreferences = null;
private SellerFavoriteItemPreferencesType sellerFavoriteItemPreferences = null;
private EndOfAuctionEmailPreferencesType endOfAuctionEmailPreferences = null;
private Boolean emailShipmentTrackingNumberPreference = null;
private Boolean requiredShipPhoneNumberPreference = null;
private UnpaidItemAssistancePreferencesType unpaidItemAssistancePreferences = null;
private PurchaseReminderEmailPreferencesType purchaseReminderEmailPreferences = null;
private Boolean sellerThirdPartyCheckoutDisabled = null;
private DispatchCutoffTimePreferencesType dispatchCutoffTimePreference = null;
private Boolean globalShippingProgramListingPreference = null;
private Boolean overrideGSPserviceWithIntlService = null;
private Boolean outOfStockControlPreference = null;
/**
* Constructor.
*/
public SetUserPreferencesCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public SetUserPreferencesCall(ApiContext apiContext) {
super(apiContext);
}
/**
* This call allows an eBay user to set/modify numerous seller account preferences.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The void object.
*/
public void setUserPreferences()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
SetUserPreferencesRequestType req;
req = new SetUserPreferencesRequestType();
if (this.bidderNoticePreferences != null)
req.setBidderNoticePreferences(this.bidderNoticePreferences);
if (this.combinedPaymentPreferences != null)
req.setCombinedPaymentPreferences(this.combinedPaymentPreferences);
if (this.crossPromotionPreferences != null)
req.setCrossPromotionPreferences(this.crossPromotionPreferences);
if (this.sellerPaymentPreferences != null)
req.setSellerPaymentPreferences(this.sellerPaymentPreferences);
if (this.sellerFavoriteItemPreferences != null)
req.setSellerFavoriteItemPreferences(this.sellerFavoriteItemPreferences);
if (this.endOfAuctionEmailPreferences != null)
req.setEndOfAuctionEmailPreferences(this.endOfAuctionEmailPreferences);
if (this.emailShipmentTrackingNumberPreference != null)
req.setEmailShipmentTrackingNumberPreference(this.emailShipmentTrackingNumberPreference);
if (this.requiredShipPhoneNumberPreference != null)
req.setRequiredShipPhoneNumberPreference(this.requiredShipPhoneNumberPreference);
if (this.unpaidItemAssistancePreferences != null)
req.setUnpaidItemAssistancePreferences(this.unpaidItemAssistancePreferences);
if (this.purchaseReminderEmailPreferences != null)
req.setPurchaseReminderEmailPreferences(this.purchaseReminderEmailPreferences);
if (this.sellerThirdPartyCheckoutDisabled != null)
req.setSellerThirdPartyCheckoutDisabled(this.sellerThirdPartyCheckoutDisabled);
if (this.dispatchCutoffTimePreference != null)
req.setDispatchCutoffTimePreference(this.dispatchCutoffTimePreference);
if (this.globalShippingProgramListingPreference != null)
req.setGlobalShippingProgramListingPreference(this.globalShippingProgramListingPreference);
if (this.overrideGSPserviceWithIntlService != null)
req.setOverrideGSPserviceWithIntlService(this.overrideGSPserviceWithIntlService);
if (this.outOfStockControlPreference != null)
req.setOutOfStockControlPreference(this.outOfStockControlPreference);
SetUserPreferencesResponseType resp = (SetUserPreferencesResponseType) execute(req);
}
/**
* Gets the SetUserPreferencesRequestType.bidderNoticePreferences.
* @return BidderNoticePreferencesType
*/
public BidderNoticePreferencesType getBidderNoticePreferences()
{
return this.bidderNoticePreferences;
}
/**
* Sets the SetUserPreferencesRequestType.bidderNoticePreferences.
* @param bidderNoticePreferences BidderNoticePreferencesType
*/
public void setBidderNoticePreferences(BidderNoticePreferencesType bidderNoticePreferences)
{
this.bidderNoticePreferences = bidderNoticePreferences;
}
/**
* Gets the SetUserPreferencesRequestType.combinedPaymentPreferences.
* @return CombinedPaymentPreferencesType
*/
public CombinedPaymentPreferencesType getCombinedPaymentPreferences()
{
return this.combinedPaymentPreferences;
}
/**
* Sets the SetUserPreferencesRequestType.combinedPaymentPreferences.
* @param combinedPaymentPreferences CombinedPaymentPreferencesType
*/
public void setCombinedPaymentPreferences(CombinedPaymentPreferencesType combinedPaymentPreferences)
{
this.combinedPaymentPreferences = combinedPaymentPreferences;
}
/**
* Gets the SetUserPreferencesRequestType.crossPromotionPreferences.
* @return CrossPromotionPreferencesType
*/
public CrossPromotionPreferencesType getCrossPromotionPreferences()
{
return this.crossPromotionPreferences;
}
/**
* Sets the SetUserPreferencesRequestType.crossPromotionPreferences.
* @param crossPromotionPreferences CrossPromotionPreferencesType
*/
public void setCrossPromotionPreferences(CrossPromotionPreferencesType crossPromotionPreferences)
{
this.crossPromotionPreferences = crossPromotionPreferences;
}
/**
* Gets the SetUserPreferencesRequestType.dispatchCutoffTimePreference.
* @return DispatchCutoffTimePreferencesType
*/
public DispatchCutoffTimePreferencesType getDispatchCutoffTimePreference()
{
return this.dispatchCutoffTimePreference;
}
/**
* Sets the SetUserPreferencesRequestType.dispatchCutoffTimePreference.
* @param dispatchCutoffTimePreference DispatchCutoffTimePreferencesType
*/
public void setDispatchCutoffTimePreference(DispatchCutoffTimePreferencesType dispatchCutoffTimePreference)
{
this.dispatchCutoffTimePreference = dispatchCutoffTimePreference;
}
/**
* Gets the SetUserPreferencesRequestType.emailShipmentTrackingNumberPreference.
* @return Boolean
*/
public Boolean getEmailShipmentTrackingNumberPreference()
{
return this.emailShipmentTrackingNumberPreference;
}
/**
* Sets the SetUserPreferencesRequestType.emailShipmentTrackingNumberPreference.
* @param emailShipmentTrackingNumberPreference Boolean
*/
public void setEmailShipmentTrackingNumberPreference(Boolean emailShipmentTrackingNumberPreference)
{
this.emailShipmentTrackingNumberPreference = emailShipmentTrackingNumberPreference;
}
/**
* Gets the SetUserPreferencesRequestType.endOfAuctionEmailPreferences.
* @return EndOfAuctionEmailPreferencesType
*/
public EndOfAuctionEmailPreferencesType getEndOfAuctionEmailPreferences()
{
return this.endOfAuctionEmailPreferences;
}
/**
* Sets the SetUserPreferencesRequestType.endOfAuctionEmailPreferences.
* @param endOfAuctionEmailPreferences EndOfAuctionEmailPreferencesType
*/
public void setEndOfAuctionEmailPreferences(EndOfAuctionEmailPreferencesType endOfAuctionEmailPreferences)
{
this.endOfAuctionEmailPreferences = endOfAuctionEmailPreferences;
}
/**
* Gets the SetUserPreferencesRequestType.globalShippingProgramListingPreference.
* @return Boolean
*/
public Boolean getGlobalShippingProgramListingPreference()
{
return this.globalShippingProgramListingPreference;
}
/**
* Sets the SetUserPreferencesRequestType.globalShippingProgramListingPreference.
* @param globalShippingProgramListingPreference Boolean
*/
public void setGlobalShippingProgramListingPreference(Boolean globalShippingProgramListingPreference)
{
this.globalShippingProgramListingPreference = globalShippingProgramListingPreference;
}
/**
* Gets the SetUserPreferencesRequestType.outOfStockControlPreference.
* @return Boolean
*/
public Boolean getOutOfStockControlPreference()
{
return this.outOfStockControlPreference;
}
/**
* Sets the SetUserPreferencesRequestType.outOfStockControlPreference.
* @param outOfStockControlPreference Boolean
*/
public void setOutOfStockControlPreference(Boolean outOfStockControlPreference)
{
this.outOfStockControlPreference = outOfStockControlPreference;
}
/**
* Gets the SetUserPreferencesRequestType.overrideGSPserviceWithIntlService.
* @return Boolean
*/
public Boolean getOverrideGSPserviceWithIntlService()
{
return this.overrideGSPserviceWithIntlService;
}
/**
* Sets the SetUserPreferencesRequestType.overrideGSPserviceWithIntlService.
* @param overrideGSPserviceWithIntlService Boolean
*/
public void setOverrideGSPserviceWithIntlService(Boolean overrideGSPserviceWithIntlService)
{
this.overrideGSPserviceWithIntlService = overrideGSPserviceWithIntlService;
}
/**
* Gets the SetUserPreferencesRequestType.purchaseReminderEmailPreferences.
* @return PurchaseReminderEmailPreferencesType
*/
public PurchaseReminderEmailPreferencesType getPurchaseReminderEmailPreferences()
{
return this.purchaseReminderEmailPreferences;
}
/**
* Sets the SetUserPreferencesRequestType.purchaseReminderEmailPreferences.
* @param purchaseReminderEmailPreferences PurchaseReminderEmailPreferencesType
*/
public void setPurchaseReminderEmailPreferences(PurchaseReminderEmailPreferencesType purchaseReminderEmailPreferences)
{
this.purchaseReminderEmailPreferences = purchaseReminderEmailPreferences;
}
/**
* Gets the SetUserPreferencesRequestType.requiredShipPhoneNumberPreference.
* @return Boolean
*/
public Boolean getRequiredShipPhoneNumberPreference()
{
return this.requiredShipPhoneNumberPreference;
}
/**
* Sets the SetUserPreferencesRequestType.requiredShipPhoneNumberPreference.
* @param requiredShipPhoneNumberPreference Boolean
*/
public void setRequiredShipPhoneNumberPreference(Boolean requiredShipPhoneNumberPreference)
{
this.requiredShipPhoneNumberPreference = requiredShipPhoneNumberPreference;
}
/**
* Gets the SetUserPreferencesRequestType.sellerFavoriteItemPreferences.
* @return SellerFavoriteItemPreferencesType
*/
public SellerFavoriteItemPreferencesType getSellerFavoriteItemPreferences()
{
return this.sellerFavoriteItemPreferences;
}
/**
* Sets the SetUserPreferencesRequestType.sellerFavoriteItemPreferences.
* @param sellerFavoriteItemPreferences SellerFavoriteItemPreferencesType
*/
public void setSellerFavoriteItemPreferences(SellerFavoriteItemPreferencesType sellerFavoriteItemPreferences)
{
this.sellerFavoriteItemPreferences = sellerFavoriteItemPreferences;
}
/**
* Gets the SetUserPreferencesRequestType.sellerPaymentPreferences.
* @return SellerPaymentPreferencesType
*/
public SellerPaymentPreferencesType getSellerPaymentPreferences()
{
return this.sellerPaymentPreferences;
}
/**
* Sets the SetUserPreferencesRequestType.sellerPaymentPreferences.
* @param sellerPaymentPreferences SellerPaymentPreferencesType
*/
public void setSellerPaymentPreferences(SellerPaymentPreferencesType sellerPaymentPreferences)
{
this.sellerPaymentPreferences = sellerPaymentPreferences;
}
/**
* Gets the SetUserPreferencesRequestType.sellerThirdPartyCheckoutDisabled.
* @return Boolean
*/
public Boolean getSellerThirdPartyCheckoutDisabled()
{
return this.sellerThirdPartyCheckoutDisabled;
}
/**
* Sets the SetUserPreferencesRequestType.sellerThirdPartyCheckoutDisabled.
* @param sellerThirdPartyCheckoutDisabled Boolean
*/
public void setSellerThirdPartyCheckoutDisabled(Boolean sellerThirdPartyCheckoutDisabled)
{
this.sellerThirdPartyCheckoutDisabled = sellerThirdPartyCheckoutDisabled;
}
/**
* Gets the SetUserPreferencesRequestType.unpaidItemAssistancePreferences.
* @return UnpaidItemAssistancePreferencesType
*/
public UnpaidItemAssistancePreferencesType getUnpaidItemAssistancePreferences()
{
return this.unpaidItemAssistancePreferences;
}
/**
* Sets the SetUserPreferencesRequestType.unpaidItemAssistancePreferences.
* @param unpaidItemAssistancePreferences UnpaidItemAssistancePreferencesType
*/
public void setUnpaidItemAssistancePreferences(UnpaidItemAssistancePreferencesType unpaidItemAssistancePreferences)
{
this.unpaidItemAssistancePreferences = unpaidItemAssistancePreferences;
}
}