net.packet.impl

Class PacketClient

java.lang.Object

net.packet.impl.PacketClient

All Implemented Interfaces:

Constants, Packet

public final class PacketClient
extends java.lang.Object
implements Packet, Constants

Packet API client implementation.

Since:

v1.0.0

Field Summary

Fields inherited from interface net.packet.Constants

ACCEPT_HDR_FORMAT, DATE_FORMAT, HOSTNAME, MEDIA_TYPE_JSON, URI_SCHEME, USER_AGENT, UTC_TIMEZONE, UTF_8

Constructor Summary

Constructors

Constructor and Description
PacketClient(java.lang.String authToken, java.lang.String version) Constructor for creating Packet API Client Instance.
PacketClient(java.lang.String authToken, java.lang.String version, org.apache.http.impl.client.CloseableHttpClient httpClient) Constructor for creating Packet API Client Instance with HTTP Client.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	acceptInvite(java.lang.String invitationId) To accept user invitation.
java.lang.Boolean	acceptTransfer(java.lang.String transferId) To accept project ownership transfer.
Email	addEmailAddress(Email email) Add email address to current user profile.
Device	createDevice(java.lang.String projectId, Device device) Creating new device on packet project.
Project	createProject(Project project) Create a project on your packet account.
SshKey	createSshKey(SshKey sshKey) To create a new SSH key on packet account.
java.lang.Boolean	declineInvite(java.lang.String invitationId) To decline user invitation.
java.lang.Boolean	declineTransfer(java.lang.String transferId) To decline project ownership transfer.
java.lang.Boolean	deleteDevice(java.lang.String deviceId) To delete a device from Packet project and deprovisions it in packet datacenter.
java.lang.Boolean	deleteEmailAddress(java.lang.String emailId) To delete email address from current user profile.
java.lang.Boolean	deleteIpAddress(java.lang.String ipAddressId) To remove an IP reservation from the project.
java.lang.Boolean	deleteMembership(java.lang.String membershipId) To deletes a membership record and also it will remove the user from the project.
java.lang.Boolean	deleteProject(java.lang.String projectId) Deletes a device and de-provisions it in our datacenter.
java.lang.Boolean	deleteSshKey(java.lang.String sshKeyId) To delete SSH key from packet account.
Metrics	deviceTraffic(java.lang.String deviceId, TrafficDirection direction, java.util.Date timeframeStart, java.util.Date timeframeEnd) To get traffic information for device.
Metrics	deviceTraffic(java.lang.String deviceId, TrafficDirection direction, java.util.Date timeframeStart, java.util.Date timeframeEnd, MetricInterval interval, TrafficBucket bucket) To get traffic information for device.
User	getCurrentUser() To get current user information.
Device	getDevice(java.lang.String deviceId) To get single device information.
Events	getDeviceEvents(java.lang.String deviceId, java.lang.Integer pageNo, java.lang.Integer perPage) To fetch all the events belongs to particular device.
Devices	getDevices(java.lang.String projectId, java.lang.Integer pageNo, java.lang.Integer perPage) To get all available devices from your packet account on particular project.
Email	getEmailAddress(java.lang.String emailId) To fetch one email address information.
Event	getEvent(java.lang.String eventId) To get single event details.
Events	getEvents(java.util.Date since, java.lang.Integer pageNo, java.lang.Integer perPage) Provides all the events from since date.
Facilities	getFacilites(java.lang.Integer pageNo, java.lang.Integer perPage) Provides a listing of available datacenters where you can provision Packet devices.
Invitation	getInvite(java.lang.String invitationId) To get particular invite details.
IpAddress	getIpAddress(java.lang.String ipAddressId) To get particular IP Address details.
IpAddresses	getIpAddresses(java.lang.String projectId) To get all available IP Addresses form packet project.
Membership	getMembership(java.lang.String membershipId) To get project membership details.
Notification	getNotification(java.lang.String notificationId) To get single notification details.
Notifications	getNotifications(java.util.Date since, java.lang.Boolean all, java.lang.Integer pageNo, java.lang.Integer perPage) To fetch all the notification from packet account.
OperatingSystems	getOperatingSystems(java.lang.Integer pageNo, java.lang.Integer perPage) Provides a listing of available operating systems to provision your new device with.
Plans	getPlans(java.lang.Integer pageNo, java.lang.Integer perPage) Provides a listing of available services plans available to provision your device on.
Project	getProject(java.lang.String projectId) Provides single project object.
Events	getProjectEvents(java.lang.String projectId, java.lang.Integer pageNo, java.lang.Integer perPage) To fetch all the events belongs to particular project.
Projects	getProjects(java.lang.Integer pageNo, java.lang.Integer perPage) Projects are a way to group devices and grant users access to them.
SshKey	getSshKey(java.lang.String sshKeyId) To get single SSH key details.
SshKeys	getSshKeys(java.lang.Integer pageNo, java.lang.Integer perPage) To get all the available SSH keys from packet account.
Transfer	getTransferInfo(java.lang.String transferId) Get the project transfer information.
User	getUser(java.lang.String userId) To get single user information.
Users	getUsers(java.lang.Integer pageNo, java.lang.Integer perPage) To get all the available users information.
Invitation	invite(java.lang.String projectId, Invitation invitation) Inviting a user to the project or adding user to the project.
java.lang.Boolean	powerOffDevice(java.lang.String deviceId) To turn-off power on your device.
java.lang.Boolean	powerOnDevice(java.lang.String deviceId) To power on your device.
java.lang.Boolean	rebootDevice(java.lang.String deviceId) To reboot device normally.
java.lang.Boolean	rescueDevice(java.lang.String deviceId) To reboot the device into rescue OS.
java.lang.Boolean	reserveIpAddress(java.lang.String projectId, ReserveIpAddress reserveIpAddress) Reserve/Request more IP address for a project.
Transfer	transferProject(java.lang.String projectId, java.lang.String membershipId) Project owners can transfer ownership of their projects to other members.
User	updateCurrentUser(User user) To update current user information.
Device	updateDevice(Device device) To update device details on packet project.
Email	updateEmailAddress(Email email) To update email address to default address or non-default.
Membership	updateMembership(Membership membership) To update membership details.
Notification	updateNotification(Notification notification) To update single notification.
Project	updateProject(Project project) Updates a project information.
SshKey	updateSshKey(SshKey sshKey) To update existing SSH key on packet account.

Methods inherited from class java.lang.Object

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

Constructor Detail

PacketClient

public PacketClient(java.lang.String authToken,
                    java.lang.String version)

Constructor for creating Packet API Client Instance.

Parameters:

authToken - authentication tokens from Packet Portal

version - API version number

PacketClient

public PacketClient(java.lang.String authToken,
                    java.lang.String version,
                    org.apache.http.impl.client.CloseableHttpClient httpClient)

Constructor for creating Packet API Client Instance with HTTP Client.

Parameters:

authToken - authentication tokens from Packet Portal

version - API version number

httpClient - Apache HTTP Client instance

Method Detail

getFacilites

public Facilities getFacilites(java.lang.Integer pageNo,
                               java.lang.Integer perPage)
                        throws PacketException

Description copied from interface: Packet

Provides a listing of available datacenters where you can provision Packet devices.

Specified by:

getFacilites in interface Packet

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Facilities

Throws:

PacketException - for HTTP status code >= 400 && < 510

getOperatingSystems

public OperatingSystems getOperatingSystems(java.lang.Integer pageNo,
                                            java.lang.Integer perPage)
                                     throws PacketException

Description copied from interface: Packet

Provides a listing of available operating systems to provision your new device with.

Specified by:

getOperatingSystems in interface Packet

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

OperatingSystems

Throws:

PacketException - for HTTP status code >= 400 && < 510

getPlans

public Plans getPlans(java.lang.Integer pageNo,
                      java.lang.Integer perPage)
               throws PacketException

Description copied from interface: Packet

Provides a listing of available services plans available to provision your device on.

Specified by:

getPlans in interface Packet

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Plans

Throws:

PacketException - for HTTP status code >= 400 && < 510

getProjects

public Projects getProjects(java.lang.Integer pageNo,
                            java.lang.Integer perPage)
                     throws PacketException,
                            HttpErrorException

Description copied from interface: Packet

Projects are a way to group devices and grant users access to them. A collection of projects that the current user is a member of.

Specified by:

getProjects in interface Packet

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Projects

Throws:

PacketException - for HTTP status code >= 400 && < 510

HttpErrorException

getProject

public Project getProject(java.lang.String projectId)
                   throws PacketException

Description copied from interface: Packet

Provides single project object.

Specified by:

getProject in interface Packet

Parameters:

projectId - a packet project id

Returns:

Project

Throws:

PacketException - for HTTP status code >= 400 && < 510

createProject

public Project createProject(Project project)
                      throws PacketException

Description copied from interface: Packet

Create a project on your packet account.

Specified by:

createProject in interface Packet

Parameters:

project - a Project instance

Returns:

Project

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateProject

public Project updateProject(Project project)
                      throws PacketException

Description copied from interface: Packet

Updates a project information. Like name, payment methods.

Specified by:

updateProject in interface Packet

Parameters:

project - a Project instance

Returns:

Project

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteProject

public java.lang.Boolean deleteProject(java.lang.String projectId)
                                throws PacketException

Description copied from interface: Packet

Deletes a device and de-provisions it in our datacenter.

Specified by:

deleteProject in interface Packet

Parameters:

projectId - a packet project id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

transferProject

public Transfer transferProject(java.lang.String projectId,
                                java.lang.String membershipId)
                         throws PacketException

Description copied from interface: Packet

Project owners can transfer ownership of their projects to other members.

Specified by:

transferProject in interface Packet

Parameters:

projectId - a packet project id

membershipId - a packet membership id

Returns:

Transfer

Throws:

PacketException - for HTTP status code >= 400 && < 510

getTransferInfo

public Transfer getTransferInfo(java.lang.String transferId)
                         throws PacketException

Description copied from interface: Packet

Get the project transfer information.

Specified by:

getTransferInfo in interface Packet

Parameters:

transferId - project transfer id

Returns:

Transfer

Throws:

PacketException - for HTTP status code >= 400 && < 510

acceptTransfer

public java.lang.Boolean acceptTransfer(java.lang.String transferId)
                                 throws PacketException

Description copied from interface: Packet

To accept project ownership transfer.

Specified by:

acceptTransfer in interface Packet

Parameters:

transferId - project transfer id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

declineTransfer

public java.lang.Boolean declineTransfer(java.lang.String transferId)
                                  throws PacketException

Description copied from interface: Packet

To decline project ownership transfer.

Specified by:

declineTransfer in interface Packet

Parameters:

transferId - project transfer id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

getDevices

public Devices getDevices(java.lang.String projectId,
                          java.lang.Integer pageNo,
                          java.lang.Integer perPage)
                   throws PacketException

Description copied from interface: Packet

To get all available devices from your packet account on particular project.

Specified by:

getDevices in interface Packet

Parameters:

projectId - a packet project id

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Devices

Throws:

PacketException - for HTTP status code >= 400 && < 510

getDevice

public Device getDevice(java.lang.String deviceId)
                 throws PacketException

Description copied from interface: Packet

To get single device information.

Specified by:

getDevice in interface Packet

Parameters:

deviceId - a packet device id

Returns:

Device

Throws:

PacketException - for HTTP status code >= 400 && < 510

createDevice

public Device createDevice(java.lang.String projectId,
                           Device device)
                    throws PacketException

Description copied from interface: Packet

Creating new device on packet project.

Specified by:

createDevice in interface Packet

Parameters:

projectId - a packet project id

device - a Device instance

Returns:

Device

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateDevice

public Device updateDevice(Device device)
                    throws PacketException

Description copied from interface: Packet

To update device details on packet project.

Specified by:

updateDevice in interface Packet

Parameters:

device - a Device instance

Returns:

Device

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteDevice

public java.lang.Boolean deleteDevice(java.lang.String deviceId)
                               throws PacketException

Description copied from interface: Packet

To delete a device from Packet project and deprovisions it in packet datacenter.

Specified by:

deleteDevice in interface Packet

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

powerOnDevice

public java.lang.Boolean powerOnDevice(java.lang.String deviceId)
                                throws PacketException

Description copied from interface: Packet

To power on your device.

Specified by:

powerOnDevice in interface Packet

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

powerOffDevice

public java.lang.Boolean powerOffDevice(java.lang.String deviceId)
                                 throws PacketException

Description copied from interface: Packet

To turn-off power on your device.

Specified by:

powerOffDevice in interface Packet

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

rebootDevice

public java.lang.Boolean rebootDevice(java.lang.String deviceId)
                               throws PacketException

Description copied from interface: Packet

To reboot device normally.

Specified by:

rebootDevice in interface Packet

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

rescueDevice

public java.lang.Boolean rescueDevice(java.lang.String deviceId)
                               throws PacketException

Description copied from interface: Packet

To reboot the device into rescue OS.

Specified by:

rescueDevice in interface Packet

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

deviceTraffic

public Metrics deviceTraffic(java.lang.String deviceId,
                             TrafficDirection direction,
                             java.util.Date timeframeStart,
                             java.util.Date timeframeEnd)
                      throws PacketException

Description copied from interface: Packet

To get traffic information for device.

Specified by:

deviceTraffic in interface Packet

Parameters:

deviceId - a packet device id

direction - a value of TrafficDirection

timeframeStart - a starting date time

timeframeEnd - a end date time

Returns:

Metrics

Throws:

PacketException - for HTTP status code >= 400 && < 510

deviceTraffic

public Metrics deviceTraffic(java.lang.String deviceId,
                             TrafficDirection direction,
                             java.util.Date timeframeStart,
                             java.util.Date timeframeEnd,
                             MetricInterval interval,
                             TrafficBucket bucket)
                      throws PacketException

Description copied from interface: Packet

To get traffic information for device.

Specified by:

deviceTraffic in interface Packet

Parameters:

deviceId - a packet device id

direction - a value of TrafficDirection

timeframeStart - a starting date time

timeframeEnd - a end date time

interval - a value of MetricInterval

bucket - a value of TrafficBucket

Returns:

Metrics

Throws:

PacketException - for HTTP status code >= 400 && < 510

getIpAddresses

public IpAddresses getIpAddresses(java.lang.String projectId)
                           throws PacketException

Description copied from interface: Packet

To get all available IP Addresses form packet project.

Specified by:

getIpAddresses in interface Packet

Parameters:

projectId - a packet project id

Returns:

IpAddresses

Throws:

PacketException - for HTTP status code >= 400 && < 510

reserveIpAddress

public java.lang.Boolean reserveIpAddress(java.lang.String projectId,
                                          ReserveIpAddress reserveIpAddress)
                                   throws PacketException

Description copied from interface: Packet

Reserve/Request more IP address for a project.

Specified by:

reserveIpAddress in interface Packet

Parameters:

projectId - a packet project id

reserveIpAddress - a instance of ReserveIpAddress

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

getIpAddress

public IpAddress getIpAddress(java.lang.String ipAddressId)
                       throws PacketException

Description copied from interface: Packet

To get particular IP Address details.

Specified by:

getIpAddress in interface Packet

Parameters:

ipAddressId - id of the IP address

Returns:

IpAddress

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteIpAddress

public java.lang.Boolean deleteIpAddress(java.lang.String ipAddressId)
                                  throws PacketException

Description copied from interface: Packet

To remove an IP reservation from the project.

Specified by:

deleteIpAddress in interface Packet

Parameters:

ipAddressId - id of the IP address

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

getUsers

public Users getUsers(java.lang.Integer pageNo,
                      java.lang.Integer perPage)
               throws PacketException

Description copied from interface: Packet

To get all the available users information.

Specified by:

getUsers in interface Packet

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Users

Throws:

PacketException - for HTTP status code >= 400 && < 510

getUser

public User getUser(java.lang.String userId)
             throws PacketException

Description copied from interface: Packet

To get single user information.

Specified by:

getUser in interface Packet

Parameters:

userId - packet user id

Returns:

User

Throws:

PacketException - for HTTP status code >= 400 && < 510

getCurrentUser

public User getCurrentUser()
                    throws PacketException

Description copied from interface: Packet

To get current user information.

Specified by:

getCurrentUser in interface Packet

Returns:

User

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateCurrentUser

public User updateCurrentUser(User user)
                       throws PacketException

Description copied from interface: Packet

To update current user information.

Specified by:

updateCurrentUser in interface Packet

Parameters:

user - a instance of User

Returns:

User

Throws:

PacketException - for HTTP status code >= 400 && < 510

getMembership

public Membership getMembership(java.lang.String membershipId)
                         throws PacketException

Description copied from interface: Packet

To get project membership details.

Specified by:

getMembership in interface Packet

Parameters:

membershipId - project membership id

Returns:

Membership

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateMembership

public Membership updateMembership(Membership membership)
                            throws PacketException

Description copied from interface: Packet

To update membership details.

Specified by:

updateMembership in interface Packet

Parameters:

membership - a instance of Membership

Returns:

Membership

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteMembership

public java.lang.Boolean deleteMembership(java.lang.String membershipId)
                                   throws PacketException

Description copied from interface: Packet

To deletes a membership record and also it will remove the user from the project.

Specified by:

deleteMembership in interface Packet

Parameters:

membershipId - project membership id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

getSshKeys

public SshKeys getSshKeys(java.lang.Integer pageNo,
                          java.lang.Integer perPage)
                   throws PacketException

Description copied from interface: Packet

To get all the available SSH keys from packet account.

Specified by:

getSshKeys in interface Packet

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

SshKeys

Throws:

PacketException - for HTTP status code >= 400 && < 510

getSshKey

public SshKey getSshKey(java.lang.String sshKeyId)
                 throws PacketException

Description copied from interface: Packet

To get single SSH key details.

Specified by:

getSshKey in interface Packet

Parameters:

sshKeyId - id of the SSH key

Returns:

SshKey

Throws:

PacketException - for HTTP status code >= 400 && < 510

createSshKey

public SshKey createSshKey(SshKey sshKey)
                    throws PacketException

Description copied from interface: Packet

To create a new SSH key on packet account.

Specified by:

createSshKey in interface Packet

Parameters:

sshKey - a instance of SshKey

Returns:

SshKey

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateSshKey

public SshKey updateSshKey(SshKey sshKey)
                    throws PacketException

Description copied from interface: Packet

To update existing SSH key on packet account.

Specified by:

updateSshKey in interface Packet

Parameters:

sshKey - a instance of SshKey

Returns:

SshKey

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteSshKey

public java.lang.Boolean deleteSshKey(java.lang.String sshKeyId)
                               throws PacketException

Description copied from interface: Packet

To delete SSH key from packet account.

Specified by:

deleteSshKey in interface Packet

Parameters:

sshKeyId - a instance of SshKey

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

invite

public Invitation invite(java.lang.String projectId,
                         Invitation invitation)
                  throws PacketException

Description copied from interface: Packet

Inviting a user to the project or adding user to the project.

Specified by:

invite in interface Packet

Parameters:

projectId - a packet project id

invitation - a instance of Invitation

Returns:

Invitation

Throws:

PacketException - for HTTP status code >= 400 && < 510

getInvite

public Invitation getInvite(java.lang.String invitationId)
                     throws PacketException

Description copied from interface: Packet

To get particular invite details.

Specified by:

getInvite in interface Packet

Parameters:

invitationId - a user invitation id

Returns:

Invitation

Throws:

PacketException - for HTTP status code >= 400 && < 510

acceptInvite

public java.lang.Boolean acceptInvite(java.lang.String invitationId)
                               throws PacketException

Description copied from interface: Packet

To accept user invitation.

Specified by:

acceptInvite in interface Packet

Parameters:

invitationId - a user invitation id

Returns:

Invitation

Throws:

PacketException - for HTTP status code >= 400 && < 510

declineInvite

public java.lang.Boolean declineInvite(java.lang.String invitationId)
                                throws PacketException

Description copied from interface: Packet

To decline user invitation.

Specified by:

declineInvite in interface Packet

Parameters:

invitationId - a user invitation id

Returns:

Invitation

Throws:

PacketException - for HTTP status code >= 400 && < 510

getEvents

public Events getEvents(java.util.Date since,
                        java.lang.Integer pageNo,
                        java.lang.Integer perPage)
                 throws PacketException

Description copied from interface: Packet

Provides all the events from since date. This method returns event details regardless of projects, devices.

Specified by:

getEvents in interface Packet

Parameters:

since - date time of events to fetch

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Events

Throws:

PacketException - for HTTP status code >= 400 && < 510

getProjectEvents

public Events getProjectEvents(java.lang.String projectId,
                               java.lang.Integer pageNo,
                               java.lang.Integer perPage)
                        throws PacketException

Description copied from interface: Packet

To fetch all the events belongs to particular project.

Specified by:

getProjectEvents in interface Packet

Parameters:

projectId - packet project id

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Events

Throws:

PacketException - for HTTP status code >= 400 && < 510

getDeviceEvents

public Events getDeviceEvents(java.lang.String deviceId,
                              java.lang.Integer pageNo,
                              java.lang.Integer perPage)
                       throws PacketException

Description copied from interface: Packet

To fetch all the events belongs to particular device.

Specified by:

getDeviceEvents in interface Packet

Parameters:

deviceId - packet device id

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Events

Throws:

PacketException - for HTTP status code >= 400 && < 510

getEvent

public Event getEvent(java.lang.String eventId)
               throws PacketException

Description copied from interface: Packet

To get single event details.

Specified by:

getEvent in interface Packet

Parameters:

eventId - id of project or device event id

Returns:

Event

Throws:

PacketException - for HTTP status code >= 400 && < 510

getNotifications

public Notifications getNotifications(java.util.Date since,
                                      java.lang.Boolean all,
                                      java.lang.Integer pageNo,
                                      java.lang.Integer perPage)
                               throws PacketException

Description copied from interface: Packet

To fetch all the notification from packet account.

Specified by:

getNotifications in interface Packet

Parameters:

since - date time of notifications to fetch

all - to include read notification too

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Notifications

Throws:

PacketException - for HTTP status code >= 400 && < 510

getNotification

public Notification getNotification(java.lang.String notificationId)
                             throws PacketException

Description copied from interface: Packet

To get single notification details.

Specified by:

getNotification in interface Packet

Parameters:

notificationId - id of the packet notifications

Returns:

Notification

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateNotification

public Notification updateNotification(Notification notification)
                                throws PacketException

Description copied from interface: Packet

To update single notification. Currently you can only mark as read.

Specified by:

updateNotification in interface Packet

Parameters:

notification - a instance of the Notification

Returns:

Notification

Throws:

PacketException - for HTTP status code >= 400 && < 510

addEmailAddress

public Email addEmailAddress(Email email)
                      throws PacketException

Description copied from interface: Packet

Add email address to current user profile.

Specified by:

addEmailAddress in interface Packet

Parameters:

email - a valid email address

Returns:

Email

Throws:

PacketException - for HTTP status code >= 400 && < 510

getEmailAddress

public Email getEmailAddress(java.lang.String emailId)
                      throws PacketException

Description copied from interface: Packet

To fetch one email address information.

Specified by:

getEmailAddress in interface Packet

Parameters:

emailId - id of the email address record

Returns:

Email

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateEmailAddress

public Email updateEmailAddress(Email email)
                         throws PacketException

Description copied from interface: Packet

To update email address to default address or non-default.

Specified by:

updateEmailAddress in interface Packet

Parameters:

email - a instance of Email

Returns:

Email

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteEmailAddress

public java.lang.Boolean deleteEmailAddress(java.lang.String emailId)
                                     throws PacketException

Description copied from interface: Packet

To delete email address from current user profile.

Specified by:

deleteEmailAddress in interface Packet

Parameters:

emailId - id of the email address record

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510