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

Class LineItemGroupsClient

  • public class LineItemGroupsClient
extends java.lang.Object

    • Field Detail

      • 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

      • getByIdV1

        public LineItemGroup1 getByIdV1​(java.lang.String id)
        Retrieves a LineItemGroup the caller owns, is a payment counterparty on, or is the destination driver for. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroup1)

      • getByIdV1

        public LineItemGroup1 getByIdV1​(java.lang.String id,
                                RequestOptions requestOptions)
        Retrieves a LineItemGroup the caller owns, is a payment counterparty on, or is the destination driver for. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroup1)

      • getLineItemsV1

        public LineItemGroupLineItemsRes getLineItemsV1​(java.lang.String lineItemGroupId)
        Retrieves all LineItems referenced by a LineItemGroup the caller can access. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroupLineItemsRes)

      • getLineItemsV1

        public LineItemGroupLineItemsRes getLineItemsV1​(java.lang.String lineItemGroupId,
                                                RequestOptions requestOptions)
        Retrieves all LineItems referenced by a LineItemGroup the caller can access. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroupLineItemsRes)

      • listV1

        public LineItemGroupListRes listV1()
        Lists LineItemGroups the caller owns, is a payment counterparty on, or is the destination driver for. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroupListRes)

      • listV1

        public LineItemGroupListRes listV1​(LineItemGroupsListV1Request request)
        Lists LineItemGroups the caller owns, is a payment counterparty on, or is the destination driver for. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroupListRes)

      • adHocCreateV1

        public LineItemGroup1 adHocCreateV1​(LineItemGroupAdHocCreateClientReq request)
        Creates a detached ad-hoc LineItemGroup. The LIG is not linked to any TaskGroup at create time — operator follows up with /shipping/task_groups/attach_lig_to_<vector>/v1 to populate the TG vector link field and the task_group_id back-ref together (one txn). | authz: allowed_org_types=[provider, shipper], min_org_role=operator | (LineItemGroupAdHocCreateClientReq) -> (LineItemGroup1)

      • adHocCreateV1

        public LineItemGroup1 adHocCreateV1​(LineItemGroupAdHocCreateClientReq request,
                                    RequestOptions requestOptions)
        Creates a detached ad-hoc LineItemGroup. The LIG is not linked to any TaskGroup at create time — operator follows up with /shipping/task_groups/attach_lig_to_<vector>/v1 to populate the TG vector link field and the task_group_id back-ref together (one txn). | authz: allowed_org_types=[provider, shipper], min_org_role=operator | (LineItemGroupAdHocCreateClientReq) -> (LineItemGroup1)

      • adHocAddLineItemV1

        public LineItemGroup1 adHocAddLineItemV1​(java.lang.String lineItemGroupId,
                                         LineItemClientCreate1 request)
        Appends an owner-direct AD_HOC LineItem to the amendment bucket of a LineItemGroup that has not yet been finalized. The agreement bucket is reserved for the original deal at creation; everything added after lands in amendment. | authz_personas=[lig_org_operators] | (LineItemClientCreate1) -> (LineItemGroup1)

      • adHocAddLineItemV1

        public LineItemGroup1 adHocAddLineItemV1​(java.lang.String lineItemGroupId,
                                         LineItemClientCreate1 request,
                                         RequestOptions requestOptions)
        Appends an owner-direct AD_HOC LineItem to the amendment bucket of a LineItemGroup that has not yet been finalized. The agreement bucket is reserved for the original deal at creation; everything added after lands in amendment. | authz_personas=[lig_org_operators] | (LineItemClientCreate1) -> (LineItemGroup1)

      • adHocRemoveLineItemV1

        public LineItemGroup1 adHocRemoveLineItemV1​(java.lang.String lineItemGroupId,
                                            java.lang.String lineItemId)
        Removes an AD_HOC LineItem from a LineItemGroup that has not yet been finalized. | authz_personas=[lig_org_operators] | () -> (LineItemGroup1)

      • adHocRemoveLineItemV1

        public LineItemGroup1 adHocRemoveLineItemV1​(java.lang.String lineItemGroupId,
                                            java.lang.String lineItemId,
                                            RequestOptions requestOptions)
        Removes an AD_HOC LineItem from a LineItemGroup that has not yet been finalized. | authz_personas=[lig_org_operators] | () -> (LineItemGroup1)

      • finalizeV1

        public LineItemGroup1 finalizeV1​(java.lang.String lineItemGroupId)
        Locks a LineItemGroup, transitioning STAGED → FINALIZED. Required precondition for attaching to a Statement. Owner-only. Rejects if the LIG has no items in agreement_line_item_ids ∪ amendment_line_item_ids, or if pending_line_item_ids is non-empty (counterparty proposals must be resolved first). | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

      • finalizeV1

        public LineItemGroup1 finalizeV1​(java.lang.String lineItemGroupId,
                                 RequestOptions requestOptions)
        Locks a LineItemGroup, transitioning STAGED → FINALIZED. Required precondition for attaching to a Statement. Owner-only. Rejects if the LIG has no items in agreement_line_item_ids ∪ amendment_line_item_ids, or if pending_line_item_ids is non-empty (counterparty proposals must be resolved first). | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

      • proposeLineItemV1

        public LineItemGroup1 proposeLineItemV1​(java.lang.String lineItemGroupId,
                                        LineItemClientCreate1 request)
        Counterparty proposes a draft AD_HOC LineItem on a non-FINALIZED LineItemGroup. The item lands in pending_line_item_ids with ad_hoc__status=PENDING; the owner resolves it via approve/deny. Caller must be on the LIG (origin or destination) but not the owner. | authz_personas=[lig_org_operators] | (LineItemClientCreate1) -> (LineItemGroup1)

      • proposeLineItemV1

        public LineItemGroup1 proposeLineItemV1​(java.lang.String lineItemGroupId,
                                        LineItemClientCreate1 request,
                                        RequestOptions requestOptions)
        Counterparty proposes a draft AD_HOC LineItem on a non-FINALIZED LineItemGroup. The item lands in pending_line_item_ids with ad_hoc__status=PENDING; the owner resolves it via approve/deny. Caller must be on the LIG (origin or destination) but not the owner. | authz_personas=[lig_org_operators] | (LineItemClientCreate1) -> (LineItemGroup1)

      • withdrawLineItemV1

        public LineItemGroup1 withdrawLineItemV1​(java.lang.String lineItemGroupId,
                                         java.lang.String lineItemId)
        Counterparty pulls back their own pending LineItem on a non-FINALIZED LineItemGroup. Only the proposing org can withdraw; the LineItem doc is deleted (no breadcrumb). | authz_personas=[lig_org_operators] | () -> (LineItemGroup1)

      • withdrawLineItemV1

        public LineItemGroup1 withdrawLineItemV1​(java.lang.String lineItemGroupId,
                                         java.lang.String lineItemId,
                                         RequestOptions requestOptions)
        Counterparty pulls back their own pending LineItem on a non-FINALIZED LineItemGroup. Only the proposing org can withdraw; the LineItem doc is deleted (no breadcrumb). | authz_personas=[lig_org_operators] | () -> (LineItemGroup1)

      • approveLineItemV1

        public LineItemGroup1 approveLineItemV1​(java.lang.String lineItemGroupId,
                                        java.lang.String lineItemId)
        Owner approves a counterparty-proposed LineItem on a non-FINALIZED LineItemGroup, moving it from pending_line_item_ids to amendment_line_item_ids and stamping ad_hoc__status=APPROVED. The agreement bucket is reserved for the original deal at creation; counterparty additions land in amendment by construction. | authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

      • approveLineItemV1

        public LineItemGroup1 approveLineItemV1​(java.lang.String lineItemGroupId,
                                        java.lang.String lineItemId,
                                        RequestOptions requestOptions)
        Owner approves a counterparty-proposed LineItem on a non-FINALIZED LineItemGroup, moving it from pending_line_item_ids to amendment_line_item_ids and stamping ad_hoc__status=APPROVED. The agreement bucket is reserved for the original deal at creation; counterparty additions land in amendment by construction. | authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

      • denyLineItemV1

        public LineItemGroup1 denyLineItemV1​(java.lang.String lineItemGroupId,
                                     java.lang.String lineItemId)
        Owner denies a counterparty-proposed LineItem on a non-FINALIZED LineItemGroup, moving it from pending_line_item_ids to denied_line_item_ids and stamping ad_hoc__status=DENIED. | authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

      • denyLineItemV1

        public LineItemGroup1 denyLineItemV1​(java.lang.String lineItemGroupId,
                                     java.lang.String lineItemId,
                                     RequestOptions requestOptions)
        Owner denies a counterparty-proposed LineItem on a non-FINALIZED LineItemGroup, moving it from pending_line_item_ids to denied_line_item_ids and stamping ad_hoc__status=DENIED. | authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)

      • deleteV1

        public boolean deleteV1​(java.lang.String lineItemGroupId)
        Owner-only operator cleanup: deletes a STAGED LineItemGroup and cascades. Cascades: (1) deletes every LineItem referenced across the four buckets (agreement / amendment / pending / denied); (2) if the LIG is attached to a parent TaskGroup vector, clears that vector's _line_item_group_id and _rate_sheet_id (the LIG's task_group_id back-ref disappears with the LIG itself). Refuses if the LIG is already attached to a Statement (defense-in-depth — should be unreachable since attach requires FINALIZED). FINALIZED-or-beyond LIGs cannot be deleted (audit records). | authz_personas=[lig_owner_operators] | () -> (bool)

      • deleteV1

        public boolean deleteV1​(java.lang.String lineItemGroupId,
                        RequestOptions requestOptions)
        Owner-only operator cleanup: deletes a STAGED LineItemGroup and cascades. Cascades: (1) deletes every LineItem referenced across the four buckets (agreement / amendment / pending / denied); (2) if the LIG is attached to a parent TaskGroup vector, clears that vector's _line_item_group_id and _rate_sheet_id (the LIG's task_group_id back-ref disappears with the LIG itself). Refuses if the LIG is already attached to a Statement (defense-in-depth — should be unreachable since attach requires FINALIZED). FINALIZED-or-beyond LIGs cannot be deleted (audit records). | authz_personas=[lig_owner_operators] | () -> (bool)

      • fromRateSheetCreateForShipperPayProviderV1

        public LineItemGroup1 fromRateSheetCreateForShipperPayProviderV1​(CreateLigFromRateSheetForVectorClientReq request)
        Atomically materialises a STAGED LineItemGroup from a rate sheet AND attaches it to the SPP vector of the named TaskGroup (one transaction; both sides of the LIG ↔ TG link populated together). Auto-resolves the rate sheet via RateSheetMapping1 unless body.rate_sheet_id is provided. Rejects if the SPP vector already has a LIG attached, or if a billing ledger period is attached (rate-sheet/ledger exclusivity). | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (CreateLigFromRateSheetForVectorClientReq) -> (LineItemGroup1)

      • fromRateSheetCreateForShipperPayProviderV1

        public LineItemGroup1 fromRateSheetCreateForShipperPayProviderV1​(CreateLigFromRateSheetForVectorClientReq request,
                                                                 RequestOptions requestOptions)
        Atomically materialises a STAGED LineItemGroup from a rate sheet AND attaches it to the SPP vector of the named TaskGroup (one transaction; both sides of the LIG ↔ TG link populated together). Auto-resolves the rate sheet via RateSheetMapping1 unless body.rate_sheet_id is provided. Rejects if the SPP vector already has a LIG attached, or if a billing ledger period is attached (rate-sheet/ledger exclusivity). | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (CreateLigFromRateSheetForVectorClientReq) -> (LineItemGroup1)

      • fromRateSheetCreateForProviderPayProviderV1

        public LineItemGroup1 fromRateSheetCreateForProviderPayProviderV1​(CreateLigFromRateSheetForVectorClientReq request)
        Atomically materialises a STAGED LineItemGroup from a rate sheet AND attaches it to the PPP vector of the named TaskGroup (one transaction; both sides of the LIG ↔ TG link populated together). Auto-resolves the rate sheet via RateSheetMapping1 unless body.rate_sheet_id is provided. Rejects if the PPP vector already has a LIG attached, or if a billing ledger period is attached (rate-sheet/ledger exclusivity). | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (CreateLigFromRateSheetForVectorClientReq) -> (LineItemGroup1)

      • fromRateSheetCreateForProviderPayProviderV1

        public LineItemGroup1 fromRateSheetCreateForProviderPayProviderV1​(CreateLigFromRateSheetForVectorClientReq request,
                                                                  RequestOptions requestOptions)
        Atomically materialises a STAGED LineItemGroup from a rate sheet AND attaches it to the PPP vector of the named TaskGroup (one transaction; both sides of the LIG ↔ TG link populated together). Auto-resolves the rate sheet via RateSheetMapping1 unless body.rate_sheet_id is provided. Rejects if the PPP vector already has a LIG attached, or if a billing ledger period is attached (rate-sheet/ledger exclusivity). | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (CreateLigFromRateSheetForVectorClientReq) -> (LineItemGroup1)

      • fromRateSheetCreateForProviderPayDriverV1

        public LineItemGroup1 fromRateSheetCreateForProviderPayDriverV1​(CreateLigFromRateSheetForVectorClientReq request)
        Atomically materialises a STAGED LineItemGroup from a rate sheet AND attaches it to the PPD vector of the named TaskGroup (one transaction; both sides of the LIG ↔ TG link populated together). Auto-resolves the rate sheet via RateSheetMapping1 unless body.rate_sheet_id is provided. Rejects if the PPD vector already has a LIG attached, or if a billing ledger period is attached (rate-sheet/ledger exclusivity). | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (CreateLigFromRateSheetForVectorClientReq) -> (LineItemGroup1)

      • fromRateSheetCreateForProviderPayDriverV1

        public LineItemGroup1 fromRateSheetCreateForProviderPayDriverV1​(CreateLigFromRateSheetForVectorClientReq request,
                                                                RequestOptions requestOptions)
        Atomically materialises a STAGED LineItemGroup from a rate sheet AND attaches it to the PPD vector of the named TaskGroup (one transaction; both sides of the LIG ↔ TG link populated together). Auto-resolves the rate sheet via RateSheetMapping1 unless body.rate_sheet_id is provided. Rejects if the PPD vector already has a LIG attached, or if a billing ledger period is attached (rate-sheet/ledger exclusivity). | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (CreateLigFromRateSheetForVectorClientReq) -> (LineItemGroup1)