Package com.chrt.api.resources.shipperpaycourierlineitemgroups

Class AsyncShipperPayCourierLineItemGroupsClient

java.lang.Object

com.chrt.api.resources.shipperpaycourierlineitemgroups.AsyncShipperPayCourierLineItemGroupsClient

public class AsyncShipperPayCourierLineItemGroupsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.function.Supplier<AsyncAddLineItemsClient>	addLineItemsClient
protected ClientOptions	clientOptions
protected java.util.function.Supplier<AsyncCourierClient>	courierClient
protected java.util.function.Supplier<AsyncRemoveLineItemsClient>	removeLineItemsClient
protected java.util.function.Supplier<AsyncShipperClient>	shipperClient

Constructor Summary

Constructors

Constructor	Description
AsyncShipperPayCourierLineItemGroupsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
AsyncAddLineItemsClient	addLineItems()
java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroup1>	byTaskGroupIdV1(java.lang.String taskGroupId)	Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization.
java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroup1>	byTaskGroupIdV1(java.lang.String taskGroupId, RequestOptions requestOptions)	Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization.
AsyncCourierClient	courier()
java.util.concurrent.CompletableFuture<java.lang.String>	createV1(ShipperPayCourierLineItemGroupCreateReq request)	Creates a shipper pay courier line item group by calculating items from rate sheet and task group.
java.util.concurrent.CompletableFuture<java.lang.String>	createV1(ShipperPayCourierLineItemGroupCreateReq request, RequestOptions requestOptions)	Creates a shipper pay courier line item group by calculating items from rate sheet and task group.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteByIdV1(java.lang.String id)	Deletes a shipper pay courier line item group by its ID if not referenced by any payment.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteByIdV1(java.lang.String id, RequestOptions requestOptions)	Deletes a shipper pay courier line item group by its ID if not referenced by any payment.
java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroup1>	getByIdV1(java.lang.String id)	Retrieves a shipper pay courier line item group by its ID for the caller's courier organization.
java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroup1>	getByIdV1(java.lang.String id, RequestOptions requestOptions)	Retrieves a shipper pay courier line item group by its ID for the caller's courier organization.
java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroupServerCreate1>	previewV1(ShipperPayCourierLineItemGroupCreateReq request)	Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroupServerCreate1>	previewV1(ShipperPayCourierLineItemGroupCreateReq request, RequestOptions requestOptions)	Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
AsyncRemoveLineItemsClient	removeLineItems()
AsyncShipperClient	shipper()
AsyncRawShipperPayCourierLineItemGroupsClient	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

shipperClient

protected final java.util.function.Supplier<AsyncShipperClient> shipperClient

courierClient

protected final java.util.function.Supplier<AsyncCourierClient> courierClient

addLineItemsClient

protected final java.util.function.Supplier<AsyncAddLineItemsClient> addLineItemsClient

removeLineItemsClient

protected final java.util.function.Supplier<AsyncRemoveLineItemsClient> removeLineItemsClient

Constructor Detail

AsyncShipperPayCourierLineItemGroupsClient

public AsyncShipperPayCourierLineItemGroupsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawShipperPayCourierLineItemGroupsClient withRawResponse()

Get responses with HTTP metadata like headers

getByIdV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroup1> getByIdV1(java.lang.String id)

Retrieves a shipper pay courier line item group by its ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)

getByIdV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroup1> getByIdV1(java.lang.String id,
                                                                                         RequestOptions requestOptions)

Retrieves a shipper pay courier line item group by its ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)

deleteByIdV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteByIdV1(java.lang.String id)

Deletes a shipper pay courier line item group by its ID if not referenced by any payment. | () -> (bool)

deleteByIdV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteByIdV1(java.lang.String id,
                                                                              RequestOptions requestOptions)

Deletes a shipper pay courier line item group by its ID if not referenced by any payment. | () -> (bool)

byTaskGroupIdV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroup1> byTaskGroupIdV1(java.lang.String taskGroupId)

Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)

byTaskGroupIdV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroup1> byTaskGroupIdV1(java.lang.String taskGroupId,
                                                                                               RequestOptions requestOptions)

Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)

previewV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroupServerCreate1> previewV1(ShipperPayCourierLineItemGroupCreateReq request)

Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group. | (ShipperPayCourierLineItemGroupCreateReq) -> (ShipperPayCourierLineItemGroupServerCreate1)

previewV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierLineItemGroupServerCreate1> previewV1(ShipperPayCourierLineItemGroupCreateReq request,
                                                                                                     RequestOptions requestOptions)

Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group. | (ShipperPayCourierLineItemGroupCreateReq) -> (ShipperPayCourierLineItemGroupServerCreate1)

createV1

public java.util.concurrent.CompletableFuture<java.lang.String> createV1(ShipperPayCourierLineItemGroupCreateReq request)

Creates a shipper pay courier line item group by calculating items from rate sheet and task group. | (ShipperPayCourierLineItemGroupCreateReq) -> (PydanticObjectId)

createV1

public java.util.concurrent.CompletableFuture<java.lang.String> createV1(ShipperPayCourierLineItemGroupCreateReq request,
                                                                         RequestOptions requestOptions)

Creates a shipper pay courier line item group by calculating items from rate sheet and task group. | (ShipperPayCourierLineItemGroupCreateReq) -> (PydanticObjectId)

shipper

public AsyncShipperClient shipper()

courier

public AsyncCourierClient courier()

addLineItems

public AsyncAddLineItemsClient addLineItems()

removeLineItems

public AsyncRemoveLineItemsClient removeLineItems()