Package com.chrt.api.resources.shipping.ordertemplates

Class AsyncRawOrderTemplatesClient

  • public class AsyncRawOrderTemplatesClient
extends java.lang.Object

    • Constructor Detail

      • AsyncRawOrderTemplatesClient

        public AsyncRawOrderTemplatesClient​(ClientOptions clientOptions)

    • Method Detail

      • getExpandedByIdV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrderTemplateExpanded>> getExpandedByIdV1​(java.lang.String orderTemplateId)
        Retrieves an order template with its reference columns resolved (shipper, executor orgs, drivers, directory entries). Unresolvable list references are omitted so the caller can detect dangling ids. | authz: min_org_role=operator | () -> (OrderTemplateExpanded)

      • getExpandedByIdV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrderTemplateExpanded>> getExpandedByIdV1​(java.lang.String orderTemplateId,
                                                                                                            RequestOptions requestOptions)
        Retrieves an order template with its reference columns resolved (shipper, executor orgs, drivers, directory entries). Unresolvable list references are omitted so the caller can detect dangling ids. | authz: min_org_role=operator | () -> (OrderTemplateExpanded)

      • listV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrderTemplateListRes>> listV1()
        Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description, order_input, off_chrt_reference_id_str). | authz: min_org_role=operator | () -> (OrderTemplateListRes)

      • listV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrderTemplateListRes>> listV1​(OrderTemplatesListV1Request request)
        Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description, order_input, off_chrt_reference_id_str). | authz: min_org_role=operator | () -> (OrderTemplateListRes)

      • listV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrderTemplateListRes>> listV1​(OrderTemplatesListV1Request request,
                                                                                                RequestOptions requestOptions)
        Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description, order_input, off_chrt_reference_id_str). | authz: min_org_role=operator | () -> (OrderTemplateListRes)

      • getByIdV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrderTemplate1>> getByIdV1​(java.lang.String orderTemplateId)
        Retrieves an order template by ID. | authz: min_org_role=operator | () -> (OrderTemplate1)

      • getByIdV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrderTemplate1>> getByIdV1​(java.lang.String orderTemplateId,
                                                                                             RequestOptions requestOptions)
        Retrieves an order template by ID. | authz: min_org_role=operator | () -> (OrderTemplate1)

      • deleteV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteV1​(java.lang.String orderTemplateId)
        Deletes an order template, but only when no orders were built from it (otherwise archive instead). | authz: min_org_role=operator | () -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteV1​(java.lang.String orderTemplateId,
                                                                                               RequestOptions requestOptions)
        Deletes an order template, but only when no orders were built from it (otherwise archive instead). | authz: min_org_role=operator | () -> (bool)

      • createV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.String>> createV1​(OrderTemplateClientCreate1 request)
        Creates a new order template. | authz: min_org_role=operator | (OrderTemplateClientCreate1) -> (PydanticObjectId)

      • updateV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> updateV1​(java.lang.String orderTemplateId)
        Updates an order template. | authz: min_org_role=operator | (OrderTemplateClientUpdate1) -> (bool)

      • updateV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> updateV1​(java.lang.String orderTemplateId,
                                                                                               OrderTemplateClientUpdate1 request)
        Updates an order template. | authz: min_org_role=operator | (OrderTemplateClientUpdate1) -> (bool)

      • updateV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> updateV1​(java.lang.String orderTemplateId,
                                                                                               OrderTemplateClientUpdate1 request,
                                                                                               RequestOptions requestOptions)
        Updates an order template. | authz: min_org_role=operator | (OrderTemplateClientUpdate1) -> (bool)

      • archiveV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> archiveV1​(java.lang.String orderTemplateId)
        Archives an order template by setting archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)

      • archiveV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> archiveV1​(java.lang.String orderTemplateId,
                                                                                                RequestOptions requestOptions)
        Archives an order template by setting archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)

      • unarchiveV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> unarchiveV1​(java.lang.String orderTemplateId)
        Restores an archived order template by clearing archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)

      • unarchiveV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> unarchiveV1​(java.lang.String orderTemplateId,
                                                                                                  RequestOptions requestOptions)
        Restores an archived order template by clearing archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)

      • referencesRemoveV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> referencesRemoveV1​(java.lang.String orderTemplateId,
                                                                                                         OrderTemplateRemoveReferenceReq request)
        Removes a (possibly dangling) reference id from a template column. | authz: min_org_role=operator | (OrderTemplateRemoveReferenceReq) -> (bool)

      • referencesRemoveV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> referencesRemoveV1​(java.lang.String orderTemplateId,
                                                                                                         OrderTemplateRemoveReferenceReq request,
                                                                                                         RequestOptions requestOptions)
        Removes a (possibly dangling) reference id from a template column. | authz: min_org_role=operator | (OrderTemplateRemoveReferenceReq) -> (bool)