Package com.stackone.stackone_client_java

Class Screening

java.lang.Object

com.stackone.stackone_client_java.Screening

public class Screening
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
AsyncScreening	async()	Switches to the async SDK.
ScreeningCreateScreeningOrderRequestBuilder	createScreeningOrder()	Create Screening Order
ScreeningCreateScreeningOrderResponse	createScreeningOrder(java.lang.String xAccountId, ScreeningCreateOrderRequestDto screeningCreateOrderRequestDto)	Create Screening Order
ScreeningCreateScreeningOrderResponse	createScreeningOrder(java.lang.String xAccountId, ScreeningCreateOrderRequestDto screeningCreateOrderRequestDto, java.util.Optional<Options> options)	Create Screening Order
ScreeningGetScreeningPackageRequestBuilder	getScreeningPackage()	Get Screening Package
ScreeningGetScreeningPackageResponse	getScreeningPackage(ScreeningGetScreeningPackageRequest request)	Get Screening Package
ScreeningGetScreeningPackageResponse	getScreeningPackage(ScreeningGetScreeningPackageRequest request, java.util.Optional<Options> options)	Get Screening Package
ScreeningListScreeningPackagesRequestBuilder	listScreeningPackages()	List Screening Packages
ScreeningListScreeningPackagesResponse	listScreeningPackages(ScreeningListScreeningPackagesRequest request)	List Screening Packages
ScreeningListScreeningPackagesResponse	listScreeningPackages(ScreeningListScreeningPackagesRequest request, java.util.Optional<Options> options)	List Screening Packages
ScreeningWebhookScreeningResultRequestBuilder	webhookScreeningResult()	Webhook Screening Result
ScreeningWebhookScreeningResultResponse	webhookScreeningResult(java.lang.String xAccountId, ScreeningResultWebhook screeningResultWebhook)	Webhook Screening Result
ScreeningWebhookScreeningResultResponse	webhookScreeningResult(java.lang.String xAccountId, ScreeningResultWebhook screeningResultWebhook, java.util.Optional<Options> options)	Webhook Screening Result

Methods inherited from class java.lang.Object

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

Method Detail

async

public AsyncScreening async()

Switches to the async SDK.

Returns:

The async SDK

listScreeningPackages

public ScreeningListScreeningPackagesRequestBuilder listScreeningPackages()

List Screening Packages

Returns:

The call builder

listScreeningPackages

public ScreeningListScreeningPackagesResponse listScreeningPackages(ScreeningListScreeningPackagesRequest request)
                                                             throws java.lang.Exception

List Screening Packages

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listScreeningPackages

public ScreeningListScreeningPackagesResponse listScreeningPackages(ScreeningListScreeningPackagesRequest request,
                                                                    java.util.Optional<Options> options)
                                                             throws java.lang.Exception

List Screening Packages

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getScreeningPackage

public ScreeningGetScreeningPackageRequestBuilder getScreeningPackage()

Get Screening Package

Returns:

The call builder

getScreeningPackage

public ScreeningGetScreeningPackageResponse getScreeningPackage(ScreeningGetScreeningPackageRequest request)
                                                         throws java.lang.Exception

Get Screening Package

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getScreeningPackage

public ScreeningGetScreeningPackageResponse getScreeningPackage(ScreeningGetScreeningPackageRequest request,
                                                                java.util.Optional<Options> options)
                                                         throws java.lang.Exception

Get Screening Package

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

webhookScreeningResult

public ScreeningWebhookScreeningResultRequestBuilder webhookScreeningResult()

Webhook Screening Result

Returns:

The call builder

webhookScreeningResult

public ScreeningWebhookScreeningResultResponse webhookScreeningResult(java.lang.String xAccountId,
                                                                      ScreeningResultWebhook screeningResultWebhook)
                                                               throws java.lang.Exception

Webhook Screening Result

Parameters:

xAccountId - The account identifier

screeningResultWebhook -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

webhookScreeningResult

public ScreeningWebhookScreeningResultResponse webhookScreeningResult(java.lang.String xAccountId,
                                                                      ScreeningResultWebhook screeningResultWebhook,
                                                                      java.util.Optional<Options> options)
                                                               throws java.lang.Exception

Webhook Screening Result

Parameters:

xAccountId - The account identifier

screeningResultWebhook -

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createScreeningOrder

public ScreeningCreateScreeningOrderRequestBuilder createScreeningOrder()

Create Screening Order

Returns:

The call builder

createScreeningOrder

public ScreeningCreateScreeningOrderResponse createScreeningOrder(java.lang.String xAccountId,
                                                                  ScreeningCreateOrderRequestDto screeningCreateOrderRequestDto)
                                                           throws java.lang.Exception

Create Screening Order

Parameters:

xAccountId - The account identifier

screeningCreateOrderRequestDto -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createScreeningOrder

public ScreeningCreateScreeningOrderResponse createScreeningOrder(java.lang.String xAccountId,
                                                                  ScreeningCreateOrderRequestDto screeningCreateOrderRequestDto,
                                                                  java.util.Optional<Options> options)
                                                           throws java.lang.Exception

Create Screening Order

Parameters:

xAccountId - The account identifier

screeningCreateOrderRequestDto -

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails