Package com.chrt.api.resources.shipperpaycourierlineitemgroups

Class RawShipperPayCourierLineItemGroupsClient

java.lang.Object

com.chrt.api.resources.shipperpaycourierlineitemgroups.RawShipperPayCourierLineItemGroupsClient

public class RawShipperPayCourierLineItemGroupsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawShipperPayCourierLineItemGroupsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<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.
ChrtApiHttpResponse<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.
ChrtApiHttpResponse<java.lang.String>	createV1(ShipperPayCourierLineItemGroupCreateReq request)	Creates a shipper pay courier line item group by calculating items from rate sheet and task group.
ChrtApiHttpResponse<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.
ChrtApiHttpResponse<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.
ChrtApiHttpResponse<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.
ChrtApiHttpResponse<ShipperPayCourierLineItemGroup1>	getByIdV1(java.lang.String id)	Retrieves a shipper pay courier line item group by its ID for the caller's courier organization.
ChrtApiHttpResponse<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.
ChrtApiHttpResponse<ShipperPayCourierLineItemGroupServerCreate1>	previewV1(ShipperPayCourierLineItemGroupCreateReq request)	Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
ChrtApiHttpResponse<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.

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

RawShipperPayCourierLineItemGroupsClient

public RawShipperPayCourierLineItemGroupsClient(ClientOptions clientOptions)

Method Detail

getByIdV1

public ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<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)