com.paypal.sdk.models

Class OrderTrackerRequest

java.lang.Object

com.paypal.sdk.models.OrderTrackerRequest

public class OrderTrackerRequest
extends Object

This is a model class for OrderTrackerRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderTrackerRequest.Builder Class to build instances of OrderTrackerRequest.

Constructor Summary

Constructors

Constructor and Description
OrderTrackerRequest() Default constructor.
OrderTrackerRequest(String captureId, String trackingNumber, ShipmentCarrier carrier, String carrierNameOther, Boolean notifyPayer, List<OrderTrackerItem> items) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
String	getCaptureId() Getter for CaptureId.
ShipmentCarrier	getCarrier() Getter for Carrier.
String	getCarrierNameOther() Getter for CarrierNameOther.
List<OrderTrackerItem>	getItems() Getter for Items.
Boolean	getNotifyPayer() Getter for NotifyPayer.
String	getTrackingNumber() Getter for TrackingNumber.
void	setCaptureId(String captureId) Setter for CaptureId.
void	setCarrier(ShipmentCarrier carrier) Setter for Carrier.
void	setCarrierNameOther(String carrierNameOther) Setter for CarrierNameOther.
void	setItems(List<OrderTrackerItem> items) Setter for Items.
void	setNotifyPayer(Boolean notifyPayer) Setter for NotifyPayer.
void	setTrackingNumber(String trackingNumber) Setter for TrackingNumber.
OrderTrackerRequest.Builder	toBuilder() Builds a new OrderTrackerRequest.Builder object.
String	toString() Converts this OrderTrackerRequest into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrderTrackerRequest

public OrderTrackerRequest()

Default constructor.

OrderTrackerRequest

public OrderTrackerRequest(String captureId,
                           String trackingNumber,
                           ShipmentCarrier carrier,
                           String carrierNameOther,
                           Boolean notifyPayer,
                           List<OrderTrackerItem> items)

Initialization constructor.

Parameters:

captureId - String value for captureId.

trackingNumber - String value for trackingNumber.

carrier - ShipmentCarrier value for carrier.

carrierNameOther - String value for carrierNameOther.

notifyPayer - Boolean value for notifyPayer.

items - List of OrderTrackerItem value for items.

Method Detail

getTrackingNumber

public String getTrackingNumber()

Getter for TrackingNumber. The tracking number for the shipment. This property supports Unicode.

Returns:

Returns the String

setTrackingNumber

public void setTrackingNumber(String trackingNumber)

Setter for TrackingNumber. The tracking number for the shipment. This property supports Unicode.

Parameters:

trackingNumber - Value for String

getCarrier

public ShipmentCarrier getCarrier()

Getter for Carrier. The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set `carrier` to `OTHER` and set carrier name in `carrier_name_other`. For allowed values, see Carriers.

Returns:

Returns the ShipmentCarrier

setCarrier

public void setCarrier(ShipmentCarrier carrier)

Setter for Carrier. The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set `carrier` to `OTHER` and set carrier name in `carrier_name_other`. For allowed values, see Carriers.

Parameters:

carrier - Value for ShipmentCarrier

getCarrierNameOther

public String getCarrierNameOther()

Getter for CarrierNameOther. The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.

Returns:

Returns the String

setCarrierNameOther

public void setCarrierNameOther(String carrierNameOther)

Setter for CarrierNameOther. The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.

Parameters:

carrierNameOther - Value for String

getCaptureId

public String getCaptureId()

Getter for CaptureId. The PayPal capture ID.

Returns:

Returns the String

setCaptureId

public void setCaptureId(String captureId)

Setter for CaptureId. The PayPal capture ID.

Parameters:

captureId - Value for String

getNotifyPayer

public Boolean getNotifyPayer()

Getter for NotifyPayer. If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for `notify_payer`, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences.

Returns:

Returns the Boolean

setNotifyPayer

public void setNotifyPayer(Boolean notifyPayer)

Setter for NotifyPayer. If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for `notify_payer`, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences.

Parameters:

notifyPayer - Value for Boolean

getItems

public List<OrderTrackerItem> getItems()

Getter for Items. An array of details of items in the shipment.

Returns:

Returns the List of OrderTrackerItem

setItems

public void setItems(List<OrderTrackerItem> items)

Setter for Items. An array of details of items in the shipment.

Parameters:

items - Value for List of OrderTrackerItem

toString

public String toString()

Converts this OrderTrackerRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public OrderTrackerRequest.Builder toBuilder()

Builds a new OrderTrackerRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new OrderTrackerRequest.Builder object