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

Class TaskArtifactsClient

java.lang.Object

com.chrt.api.resources.shipping.taskartifacts.TaskArtifactsClient

public class TaskArtifactsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions
protected java.util.function.Supplier<S3ObjectClient>	s3ObjectClient

Constructor Summary

Constructors

Constructor	Description
TaskArtifactsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	addToTaskV1(java.lang.String taskId, AddTaskArtifactReq request)	Adds a new task artifact to a task.
java.lang.String	addToTaskV1(java.lang.String taskId, AddTaskArtifactReq request, RequestOptions requestOptions)	Adds a new task artifact to a task.
boolean	completeV1(java.lang.String taskArtifactId)	Marks a task artifact as COMPLETED.
boolean	completeV1(java.lang.String taskArtifactId, RequestOptions requestOptions)	Marks a task artifact as COMPLETED.
boolean	deleteV1(java.lang.String taskArtifactId)	Deletes a task artifact.
boolean	deleteV1(java.lang.String taskArtifactId, RequestOptions requestOptions)	Deletes a task artifact.
S3ObjectClient	s3Object()
boolean	skipV1(java.lang.String taskArtifactId)	Marks a task artifact as SKIPPED.
boolean	skipV1(java.lang.String taskArtifactId, RequestOptions requestOptions)	Marks a task artifact as SKIPPED.
RawTaskArtifactsClient	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

s3ObjectClient

protected final java.util.function.Supplier<S3ObjectClient> s3ObjectClient

Constructor Detail

TaskArtifactsClient

public TaskArtifactsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawTaskArtifactsClient withRawResponse()

Get responses with HTTP metadata like headers

addToTaskV1

public java.lang.String addToTaskV1(java.lang.String taskId,
                                    AddTaskArtifactReq request)

Adds a new task artifact to a task. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)

addToTaskV1

public java.lang.String addToTaskV1(java.lang.String taskId,
                                    AddTaskArtifactReq request,
                                    RequestOptions requestOptions)

Adds a new task artifact to a task. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)

completeV1

public boolean completeV1(java.lang.String taskArtifactId)

Marks a task artifact as COMPLETED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)

completeV1

public boolean completeV1(java.lang.String taskArtifactId,
                          RequestOptions requestOptions)

Marks a task artifact as COMPLETED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)

skipV1

public boolean skipV1(java.lang.String taskArtifactId)

Marks a task artifact as SKIPPED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)

skipV1

public boolean skipV1(java.lang.String taskArtifactId,
                      RequestOptions requestOptions)

Marks a task artifact as SKIPPED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)

deleteV1

public boolean deleteV1(java.lang.String taskArtifactId)

Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)

deleteV1

public boolean deleteV1(java.lang.String taskArtifactId,
                        RequestOptions requestOptions)

Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)

s3Object

public S3ObjectClient s3Object()