Package com.chrt.api.resources.shipping.taskartifacts.scan

Class AsyncScanClient

java.lang.Object

com.chrt.api.resources.shipping.taskartifacts.scan.AsyncScanClient

public class AsyncScanClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncScanClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.lang.Boolean>	addV1(java.lang.String taskArtifactId, AddScanPayloadReq request)	Appends a barcode/QR scan payload to a SCAN-type task artifact's expected or observed array (deduplicated).
java.util.concurrent.CompletableFuture<java.lang.Boolean>	addV1(java.lang.String taskArtifactId, AddScanPayloadReq request, RequestOptions requestOptions)	Appends a barcode/QR scan payload to a SCAN-type task artifact's expected or observed array (deduplicated).
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteV1(java.lang.String taskArtifactId, ScanDeleteV1Request request)	Removes a barcode/QR scan payload (by value) from a SCAN-type task artifact's expected or observed array.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteV1(java.lang.String taskArtifactId, ScanDeleteV1Request request, RequestOptions requestOptions)	Removes a barcode/QR scan payload (by value) from a SCAN-type task artifact's expected or observed array.
AsyncRawScanClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

AsyncScanClient

public AsyncScanClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawScanClient withRawResponse()

Get responses with HTTP metadata like headers

addV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> addV1(java.lang.String taskArtifactId,
                                                                       AddScanPayloadReq request)

Appends a barcode/QR scan payload to a SCAN-type task artifact's expected or observed array (deduplicated). | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (AddScanPayloadReq) -> (bool)

addV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> addV1(java.lang.String taskArtifactId,
                                                                       AddScanPayloadReq request,
                                                                       RequestOptions requestOptions)

Appends a barcode/QR scan payload to a SCAN-type task artifact's expected or observed array (deduplicated). | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (AddScanPayloadReq) -> (bool)

deleteV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1(java.lang.String taskArtifactId,
                                                                          ScanDeleteV1Request request)

Removes a barcode/QR scan payload (by value) from a SCAN-type task artifact's expected or observed array. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (bool)

deleteV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1(java.lang.String taskArtifactId,
                                                                          ScanDeleteV1Request request,
                                                                          RequestOptions requestOptions)

Removes a barcode/QR scan payload (by value) from a SCAN-type task artifact's expected or observed array. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (bool)