com.postalocity.sdk

Class JobClient

java.lang.Object

com.postalocity.sdk.PostalocityClient

com.postalocity.sdk.JobClient

public class JobClient
extends PostalocityClient

Field Summary

Fields inherited from class com.postalocity.sdk.PostalocityClient

gson

Constructor Summary

Constructors

Constructor and Description
JobClient()

Method Summary

Modifier and Type	Method and Description
static AddSourceResponse	addSource(AddSourceRequest request) This request will allow you to submit a source file via a remote publicly accessible url
static ApproveJobResponse	approve(java.lang.Integer id) Approves job if status requirements are met.
static JsonResponse	buildInputDocList(BuildInputDocListRequest request)
static CancelJobResponse	cancel(java.lang.Integer id) If a job is importing, this will stop the import process.
static CreateJobResponse	create(CreateJobRequest request) Creates an empty job with the specified parameters.
static DeleteJobResponse	delete(java.lang.Integer id) Deletes job.
static JsonResponse	deleteInputDocList(java.lang.Integer id)
static DeleteUploadedResponse	deleteUploaded(java.lang.Integer id, java.lang.String fileName) Deletes referenced source file and associated split out pages.
static DigestJobCsvResponse	digestCsv(DigestJobCsvRequest request) Extracts sample set from uploaded PDF so you can assign fields to columns.
static GetJobResponse	get(java.lang.Integer id, boolean includeLinks) This is used to retrive an already existing job object
static JsonResponse	getInputDocList(java.lang.Integer id)
static GetListUploadParamsResponse	getListUploadParams(java.lang.Integer id) Provides parameters required to upload a CSV containing mailing contacts to the provided job.
static GetUploadParamsResponse	getOtherUploadParams(GetUploadParamsRequest request)
static GetJobImportProgressResponse	getProgress(java.lang.Integer id) Provides import progress data on job.
static GetUploadParamsResponse	getSourceUploadParams(GetUploadParamsRequest request) Builds and return a set of upload parameters to upload to an S3 bucket.
static GetUploadedLinkResponse	getUploadedLink(GetUploadedLinkRequest request) Gets a pre signed URL to the specified file.
static ListUploadedFilesResponse	listUploadedFiles(java.lang.Integer id) This will provide a list of uploaded file names
static RunJobResponse	runJob(java.lang.Integer id) Triggers processing on job.
static GetSplitProgressResponse	splitProgress(GetSplitProgressRequest request) Progress is represented as an integer value between 0-100
static SplitSourceResponse	splitSource(SplitSourceRequest request) Once a PDF has been uploaded, it will need to be split into pages.
static JsonResponse	unApprove(java.lang.Integer id)
static JsonResponse	unAttach(java.lang.Integer id)
static UpdateJobResponse	update(UpdateJobRequest request) Updates a field within a job.
static JobZonePageContentResponse	zonePageContent(JobZonePageContentRequest request)

Methods inherited from class com.postalocity.sdk.PostalocityClient

doDelete, doGet, doPost, doPut, doUpload

Methods inherited from class java.lang.Object

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

Constructor Detail

JobClient

public JobClient()

Method Detail

get

public static GetJobResponse get(java.lang.Integer id,
                                 boolean includeLinks)
                          throws java.lang.Exception

This is used to retrive an already existing job object

Parameters:

id - Primary key of requested job object

includeLinks - If true, pre signed urls will be inserted to facilitate downloads of job files

Throws:

java.lang.Exception

create

public static CreateJobResponse create(CreateJobRequest request)
                                throws java.lang.Exception

Creates an empty job with the specified parameters.

Throws:

java.lang.Exception

update

public static UpdateJobResponse update(UpdateJobRequest request)
                                throws java.lang.Exception

Updates a field within a job.

Throws:

java.lang.Exception

getSourceUploadParams

public static GetUploadParamsResponse getSourceUploadParams(GetUploadParamsRequest request)
                                                     throws java.lang.Exception

Builds and return a set of upload parameters to upload to an S3 bucket.

Throws:

java.lang.Exception

splitSource

public static SplitSourceResponse splitSource(SplitSourceRequest request)
                                       throws java.lang.Exception

Once a PDF has been uploaded, it will need to be split into pages. This request will start the split process for a given file

It is possible to start a job without splitting but the job will run slower as it will detect the splits did not happen and trigger them before proceeding.

Throws:

java.lang.Exception

splitProgress

public static GetSplitProgressResponse splitProgress(GetSplitProgressRequest request)
                                              throws java.lang.Exception

Progress is represented as an integer value between 0-100

Throws:

java.lang.Exception

addSource

public static AddSourceResponse addSource(AddSourceRequest request)
                                   throws java.lang.Exception

This request will allow you to submit a source file via a remote publicly accessible url

With this request, you can also associate an address with the file referenced via url or, if it was previously uploaded, a file name.

Throws:

java.lang.Exception

listUploadedFiles

public static ListUploadedFilesResponse listUploadedFiles(java.lang.Integer id)
                                                   throws java.lang.Exception

This will provide a list of uploaded file names

Throws:

java.lang.Exception

getUploadedLink

public static GetUploadedLinkResponse getUploadedLink(GetUploadedLinkRequest request)
                                               throws java.lang.Exception

Gets a pre signed URL to the specified file.

Throws:

java.lang.Exception

deleteUploaded

public static DeleteUploadedResponse deleteUploaded(java.lang.Integer id,
                                                    java.lang.String fileName)
                                             throws java.lang.Exception

Deletes referenced source file and associated split out pages.

Throws:

java.lang.Exception

getListUploadParams

public static GetListUploadParamsResponse getListUploadParams(java.lang.Integer id)
                                                       throws java.lang.Exception

Provides parameters required to upload a CSV containing mailing contacts to the provided job.

Throws:

java.lang.Exception

digestCsv

public static DigestJobCsvResponse digestCsv(DigestJobCsvRequest request)
                                      throws java.lang.Exception

Extracts sample set from uploaded PDF so you can assign fields to columns.

Throws:

java.lang.Exception

runJob

public static RunJobResponse runJob(java.lang.Integer id)
                             throws java.lang.Exception

Triggers processing on job. When completed without errors, job will be in 'Inported' state.

Throws:

java.lang.Exception

cancel

public static CancelJobResponse cancel(java.lang.Integer id)
                                throws java.lang.Exception

If a job is importing, this will stop the import process.

Throws:

java.lang.Exception

delete

public static DeleteJobResponse delete(java.lang.Integer id)
                                throws java.lang.Exception

Deletes job.

Throws:

java.lang.Exception

getProgress

public static GetJobImportProgressResponse getProgress(java.lang.Integer id)
                                                throws java.lang.Exception

Provides import progress data on job.

Throws:

java.lang.Exception

approve

public static ApproveJobResponse approve(java.lang.Integer id)
                                  throws java.lang.Exception

Approves job if status requirements are met. Requirements include...

• Meter has sufficient funds to pay for job.
• Job settings remain unchanged since last run

By approving a job, you are accepting that the content of the job is accurate and ready to mail.

Throws:

java.lang.Exception

unApprove

public static JsonResponse unApprove(java.lang.Integer id)
                              throws java.lang.Exception

Throws:

java.lang.Exception

unAttach

public static JsonResponse unAttach(java.lang.Integer id)
                             throws java.lang.Exception

Throws:

java.lang.Exception

zonePageContent

public static JobZonePageContentResponse zonePageContent(JobZonePageContentRequest request)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getOtherUploadParams

public static GetUploadParamsResponse getOtherUploadParams(GetUploadParamsRequest request)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

buildInputDocList

public static JsonResponse buildInputDocList(BuildInputDocListRequest request)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getInputDocList

public static JsonResponse getInputDocList(java.lang.Integer id)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

deleteInputDocList

public static JsonResponse deleteInputDocList(java.lang.Integer id)
                                       throws java.lang.Exception

Throws:

java.lang.Exception