Package com.chrt.api.resources.shipperpaycourierlineitemgroups

Class ShipperPayCourierLineItemGroupsClient

java.lang.Object

com.chrt.api.resources.shipperpaycourierlineitemgroups.ShipperPayCourierLineItemGroupsClient

public class ShipperPayCourierLineItemGroupsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.function.Supplier<AddLineItemsClient>	addLineItemsClient
protected ClientOptions	clientOptions
protected java.util.function.Supplier<CourierClient>	courierClient
protected java.util.function.Supplier<RemoveLineItemsClient>	removeLineItemsClient
protected java.util.function.Supplier<ShipperClient>	shipperClient

Constructor Summary

Constructors

Constructor	Description
ShipperPayCourierLineItemGroupsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
AddLineItemsClient	addLineItems()
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(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.
CourierClient	courier()
java.lang.String	createV1(ShipperPayCourierLineItemGroupCreateReq request)	Creates a shipper pay courier line item group by calculating items from rate sheet and task group.
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.
boolean	deleteByIdV1(java.lang.String id)	Deletes a shipper pay courier line item group by its ID if not referenced by any payment.
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.
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(java.lang.String id, RequestOptions requestOptions)	Retrieves a shipper pay courier line item group by its ID for the caller's courier organization.
ShipperPayCourierLineItemGroupServerCreate1	previewV1(ShipperPayCourierLineItemGroupCreateReq request)	Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
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.
RemoveLineItemsClient	removeLineItems()
ShipperClient	shipper()
RawShipperPayCourierLineItemGroupsClient	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<ShipperClient> shipperClient

courierClient

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

addLineItemsClient

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

removeLineItemsClient

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

Constructor Detail

ShipperPayCourierLineItemGroupsClient

public ShipperPayCourierLineItemGroupsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawShipperPayCourierLineItemGroupsClient withRawResponse()

Get responses with HTTP metadata like headers

getByIdV1

public 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 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 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 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 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 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 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 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.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.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 ShipperClient shipper()

courier

public CourierClient courier()

addLineItems

public AddLineItemsClient addLineItems()

removeLineItems

public RemoveLineItemsClient removeLineItems()