Package com.chrt.api.resources.billing.lineitemgroups

Class LineItemGroupsClient

java.lang.Object

com.chrt.api.resources.billing.lineitemgroups.LineItemGroupsClient

public class LineItemGroupsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.function.Supplier<AdHocClient>	adHocClient
protected ClientOptions	clientOptions
protected java.util.function.Supplier<MessagesClient>	messagesClient
protected java.util.function.Supplier<S3ObjectsClient>	s3ObjectsClient

Constructor Summary

Constructors

Constructor	Description
LineItemGroupsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
AdHocClient	adHoc()
LineItemGroup1	adjustLineItemV1(java.lang.String lineItemGroupId, AdjustLineItemReq request)	Adjusts a line item within a line item group.
LineItemGroup1	adjustLineItemV1(java.lang.String lineItemGroupId, AdjustLineItemReq request, RequestOptions requestOptions)	Adjusts a line item within a line item group.
LineItemGroup1	associateWithStatementV1(java.lang.String lineItemGroupId, LineItemGroupsAssociateWithStatementV1Request request)	Associates a line item group with a statement.
LineItemGroup1	associateWithStatementV1(java.lang.String lineItemGroupId, LineItemGroupsAssociateWithStatementV1Request request, RequestOptions requestOptions)	Associates a line item group with a statement.
LineItemGroup1	calculateLineItemsV1(java.lang.String lineItemGroupId)	(Re)calculates line items for a line item group.
LineItemGroup1	calculateLineItemsV1(java.lang.String lineItemGroupId, RequestOptions requestOptions)	(Re)calculates line items for a line item group.
LineItemGroup1	finalizeV1(java.lang.String lineItemGroupId)	Finalizes a line item group.
LineItemGroup1	finalizeV1(java.lang.String lineItemGroupId, RequestOptions requestOptions)	Finalizes a line item group.
LineItemGroup1	getV1(java.lang.String lineItemGroupId)	Gets a line item group by ID.
LineItemGroup1	getV1(java.lang.String lineItemGroupId, RequestOptions requestOptions)	Gets a line item group by ID.
LineItemGroupListRes	listForCourierOrgV1()	Lists line item groups for the authenticated courier organization with filtering and pagination.
LineItemGroupListRes	listForCourierOrgV1(LineItemGroupsListForCourierOrgV1Request request)	Lists line item groups for the authenticated courier organization with filtering and pagination.
LineItemGroupListRes	listForCourierOrgV1(LineItemGroupsListForCourierOrgV1Request request, RequestOptions requestOptions)	Lists line item groups for the authenticated courier organization with filtering and pagination.
MessagesClient	messages()
Quote	quoteV1(java.lang.String taskGroupId, LineItemGroupsQuoteV1Request request)	Calculates a quote (line item group preview) for a task group and payment vector without persisting any data.
Quote	quoteV1(java.lang.String taskGroupId, LineItemGroupsQuoteV1Request request, RequestOptions requestOptions)	Calculates a quote (line item group preview) for a task group and payment vector without persisting any data.
S3ObjectsClient	s3Objects()
RawLineItemGroupsClient	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

adHocClient

protected final java.util.function.Supplier<AdHocClient> adHocClient

messagesClient

protected final java.util.function.Supplier<MessagesClient> messagesClient

s3ObjectsClient

protected final java.util.function.Supplier<S3ObjectsClient> s3ObjectsClient

Constructor Detail

LineItemGroupsClient

public LineItemGroupsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawLineItemGroupsClient withRawResponse()

Get responses with HTTP metadata like headers

getV1

public LineItemGroup1 getV1(java.lang.String lineItemGroupId)

Gets a line item group by ID. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroup1)

getV1

public LineItemGroup1 getV1(java.lang.String lineItemGroupId,
                            RequestOptions requestOptions)

Gets a line item group by ID. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroup1)

listForCourierOrgV1

public LineItemGroupListRes listForCourierOrgV1()

Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)

listForCourierOrgV1

public LineItemGroupListRes listForCourierOrgV1(LineItemGroupsListForCourierOrgV1Request request)

Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)

listForCourierOrgV1

public LineItemGroupListRes listForCourierOrgV1(LineItemGroupsListForCourierOrgV1Request request,
                                                RequestOptions requestOptions)

Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)

quoteV1

public Quote quoteV1(java.lang.String taskGroupId,
                     LineItemGroupsQuoteV1Request request)

Calculates a quote (line item group preview) for a task group and payment vector without persisting any data. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | () -> (Quote)

quoteV1

public Quote quoteV1(java.lang.String taskGroupId,
                     LineItemGroupsQuoteV1Request request,
                     RequestOptions requestOptions)

Calculates a quote (line item group preview) for a task group and payment vector without persisting any data. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | () -> (Quote)

finalizeV1

public LineItemGroup1 finalizeV1(java.lang.String lineItemGroupId)

Finalizes a line item group. LIG must be in ADJUSTABLE status. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

finalizeV1

public LineItemGroup1 finalizeV1(java.lang.String lineItemGroupId,
                                 RequestOptions requestOptions)

Finalizes a line item group. LIG must be in ADJUSTABLE status. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

calculateLineItemsV1

public LineItemGroup1 calculateLineItemsV1(java.lang.String lineItemGroupId)

(Re)calculates line items for a line item group. LIG must be PENDING_CALCULATION or ADJUSTABLE and must be associated with a TaskGroup. Note: Line item calculation normally happens automatically; this route is primarily for PENDING_CALCULATION LIGs where automatic calculation failed (e.g., due to third-party service failure). | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

calculateLineItemsV1

public LineItemGroup1 calculateLineItemsV1(java.lang.String lineItemGroupId,
                                           RequestOptions requestOptions)

(Re)calculates line items for a line item group. LIG must be PENDING_CALCULATION or ADJUSTABLE and must be associated with a TaskGroup. Note: Line item calculation normally happens automatically; this route is primarily for PENDING_CALCULATION LIGs where automatic calculation failed (e.g., due to third-party service failure). | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

associateWithStatementV1

public LineItemGroup1 associateWithStatementV1(java.lang.String lineItemGroupId,
                                               LineItemGroupsAssociateWithStatementV1Request request)

Associates a line item group with a statement. LIG must be PENDING_RATES, PENDING_CALCULATION, ADJUSTABLE, or FINALIZED (before OPEN). Statement must be STAGED. LIG payment info must match Statement. Also removes from previous statement if any. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, statement_owner_operators] | (PydanticObjectId) -> (LineItemGroup1)

associateWithStatementV1

public LineItemGroup1 associateWithStatementV1(java.lang.String lineItemGroupId,
                                               LineItemGroupsAssociateWithStatementV1Request request,
                                               RequestOptions requestOptions)

Associates a line item group with a statement. LIG must be PENDING_RATES, PENDING_CALCULATION, ADJUSTABLE, or FINALIZED (before OPEN). Statement must be STAGED. LIG payment info must match Statement. Also removes from previous statement if any. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, statement_owner_operators] | (PydanticObjectId) -> (LineItemGroup1)

adjustLineItemV1

public LineItemGroup1 adjustLineItemV1(java.lang.String lineItemGroupId,
                                       AdjustLineItemReq request)

Adjusts a line item within a line item group. LIG must be ADJUSTABLE. Adjustment can be negative beyond item.amount to serve as a credit. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (AdjustLineItemReq) -> (LineItemGroup1)

adjustLineItemV1

public LineItemGroup1 adjustLineItemV1(java.lang.String lineItemGroupId,
                                       AdjustLineItemReq request,
                                       RequestOptions requestOptions)

Adjusts a line item within a line item group. LIG must be ADJUSTABLE. Adjustment can be negative beyond item.amount to serve as a credit. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (AdjustLineItemReq) -> (LineItemGroup1)

adHoc

public AdHocClient adHoc()

messages

public MessagesClient messages()

s3Objects

public S3ObjectsClient s3Objects()