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

Class AsyncRawAdHocClient

  • public class AsyncRawAdHocClient
extends java.lang.Object

    • Constructor Detail

      • AsyncRawAdHocClient

        public AsyncRawAdHocClient​(ClientOptions clientOptions)

    • Method Detail

      • createV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<LineItemGroup1>> createV1​(CreateAdHocLineItemGroupReq request)
        Creates an ad-hoc line item group. Optionally associates with a TaskGroup. Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)

      • createV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<LineItemGroup1>> createV1​(CreateAdHocLineItemGroupReq request,
                                                                                            RequestOptions requestOptions)
        Creates an ad-hoc line item group. Optionally associates with a TaskGroup. Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)

      • addLineItemV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<LineItemGroup1>> addLineItemV1​(java.lang.String lineItemGroupId,
                                                                                                 LineItemClientCreate1 request)
        Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)

      • addLineItemV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<LineItemGroup1>> addLineItemV1​(java.lang.String lineItemGroupId,
                                                                                                 LineItemClientCreate1 request,
                                                                                                 RequestOptions requestOptions)
        Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)

      • removeLineItemV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<LineItemGroup1>> removeLineItemV1​(java.lang.String lineItemGroupId,
                                                                                                    AdHocRemoveLineItemV1Request request)
        Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)

      • removeLineItemV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<LineItemGroup1>> removeLineItemV1​(java.lang.String lineItemGroupId,
                                                                                                    AdHocRemoveLineItemV1Request request,
                                                                                                    RequestOptions requestOptions)
        Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)

      • deleteV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteV1​(java.lang.String lineItemGroupId)
        Deletes an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteV1​(java.lang.String lineItemGroupId,
                                                                                               RequestOptions requestOptions)
        Deletes an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)

      • setTaskGroupV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<LineItemGroup1>> setTaskGroupV1​(java.lang.String lineItemGroupId,
                                                                                                  SetAdHocTaskGroupReq request)
        Sets or updates the task_group_id on an existing ad-hoc LIG, deriving order_id and order_short_id from the task group. If the LIG is on a statement, recalculates the statement's order refs. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, courier_org_operators, forwarder_org_operators] | (SetAdHocTaskGroupReq) -> (LineItemGroup1)

      • setTaskGroupV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<LineItemGroup1>> setTaskGroupV1​(java.lang.String lineItemGroupId,
                                                                                                  SetAdHocTaskGroupReq request,
                                                                                                  RequestOptions requestOptions)
        Sets or updates the task_group_id on an existing ad-hoc LIG, deriving order_id and order_short_id from the task group. If the LIG is on a statement, recalculates the statement's order refs. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, courier_org_operators, forwarder_org_operators] | (SetAdHocTaskGroupReq) -> (LineItemGroup1)