Package com.chrt.api.resources.shipperpaycourierpayments

Class AsyncShipperPayCourierPaymentsClient

java.lang.Object

com.chrt.api.resources.shipperpaycourierpayments.AsyncShipperPayCourierPaymentsClient

public class AsyncShipperPayCourierPaymentsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncShipperPayCourierPaymentsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.lang.String>	createV1(CreateShipperPayCourierPaymentReq request)	Creates a shipper-to-courier payment record based on all task groups in an order.
java.util.concurrent.CompletableFuture<java.lang.String>	createV1(CreateShipperPayCourierPaymentReq request, RequestOptions requestOptions)	Creates a shipper-to-courier payment record based on all task groups in an order.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteV1(java.lang.String shipperPayCourierPaymentId)	Deletes a shipper-to-courier payment record if invoice not yet created.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteV1(java.lang.String shipperPayCourierPaymentId, RequestOptions requestOptions)	Deletes a shipper-to-courier payment record if invoice not yet created.
java.util.concurrent.CompletableFuture<ShipperPayCourierStatement1>	getByIdV1(java.lang.String shipperPayCourierPaymentId)	Retrieves a shipper pay courier payment by its ID with Stripe invoice sync.
java.util.concurrent.CompletableFuture<ShipperPayCourierStatement1>	getByIdV1(java.lang.String shipperPayCourierPaymentId, RequestOptions requestOptions)	Retrieves a shipper pay courier payment by its ID with Stripe invoice sync.
java.util.concurrent.CompletableFuture<ShipperPayCourierStatement1>	getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId)	Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync.
java.util.concurrent.CompletableFuture<ShipperPayCourierStatement1>	getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId, RequestOptions requestOptions)	Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync.
java.util.concurrent.CompletableFuture<GetShipperPayCourierPaymentsForShipperRes>	listByCourierOrgIdV1(ListPaymentsByCourierReq request)	Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync.
java.util.concurrent.CompletableFuture<GetShipperPayCourierPaymentsForShipperRes>	listByCourierOrgIdV1(ListPaymentsByCourierReq request, RequestOptions requestOptions)	Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync.
java.util.concurrent.CompletableFuture<GetShipperPayCourierPaymentsForShipperRes>	listByShipperOrgIdV1(ListPaymentsByShipperReq request)	Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync.
java.util.concurrent.CompletableFuture<GetShipperPayCourierPaymentsForShipperRes>	listByShipperOrgIdV1(ListPaymentsByShipperReq request, RequestOptions requestOptions)	Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync.
java.util.concurrent.CompletableFuture<PaymentPreviewResponse>	previewV1(CreateShipperPayCourierPaymentReq request)	Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status.
java.util.concurrent.CompletableFuture<PaymentPreviewResponse>	previewV1(CreateShipperPayCourierPaymentReq request, RequestOptions requestOptions)	Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status.
AsyncRawShipperPayCourierPaymentsClient	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

Constructor Detail

AsyncShipperPayCourierPaymentsClient

public AsyncShipperPayCourierPaymentsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawShipperPayCourierPaymentsClient withRawResponse()

Get responses with HTTP metadata like headers

getByIdV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierStatement1> getByIdV1(java.lang.String shipperPayCourierPaymentId)

Retrieves a shipper pay courier payment by its ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)

getByIdV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierStatement1> getByIdV1(java.lang.String shipperPayCourierPaymentId,
                                                                                     RequestOptions requestOptions)

Retrieves a shipper pay courier payment by its ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)

deleteV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1(java.lang.String shipperPayCourierPaymentId)

Deletes a shipper-to-courier payment record if invoice not yet created. | () -> (bool)

deleteV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1(java.lang.String shipperPayCourierPaymentId,
                                                                          RequestOptions requestOptions)

Deletes a shipper-to-courier payment record if invoice not yet created. | () -> (bool)

getByOrderIdOrShortIdV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierStatement1> getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId)

Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)

getByOrderIdOrShortIdV1

public java.util.concurrent.CompletableFuture<ShipperPayCourierStatement1> getByOrderIdOrShortIdV1(java.lang.String orderIdOrShortId,
                                                                                                   RequestOptions requestOptions)

Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)

listByShipperOrgIdV1

public java.util.concurrent.CompletableFuture<GetShipperPayCourierPaymentsForShipperRes> listByShipperOrgIdV1(ListPaymentsByShipperReq request)

Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync. | (ListPaymentsByShipperReq) -> (GetShipperPayCourierPaymentsForShipperRes)

listByShipperOrgIdV1

public java.util.concurrent.CompletableFuture<GetShipperPayCourierPaymentsForShipperRes> listByShipperOrgIdV1(ListPaymentsByShipperReq request,
                                                                                                              RequestOptions requestOptions)

Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync. | (ListPaymentsByShipperReq) -> (GetShipperPayCourierPaymentsForShipperRes)

listByCourierOrgIdV1

public java.util.concurrent.CompletableFuture<GetShipperPayCourierPaymentsForShipperRes> listByCourierOrgIdV1(ListPaymentsByCourierReq request)

Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync. | (ListPaymentsByCourierReq) -> (GetShipperPayCourierPaymentsForShipperRes)

listByCourierOrgIdV1

public java.util.concurrent.CompletableFuture<GetShipperPayCourierPaymentsForShipperRes> listByCourierOrgIdV1(ListPaymentsByCourierReq request,
                                                                                                              RequestOptions requestOptions)

Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync. | (ListPaymentsByCourierReq) -> (GetShipperPayCourierPaymentsForShipperRes)

createV1

public java.util.concurrent.CompletableFuture<java.lang.String> createV1(CreateShipperPayCourierPaymentReq request)

Creates a shipper-to-courier payment record based on all task groups in an order. | (CreateShipperPayCourierPaymentReq) -> (PydanticObjectId)

createV1

public java.util.concurrent.CompletableFuture<java.lang.String> createV1(CreateShipperPayCourierPaymentReq request,
                                                                         RequestOptions requestOptions)

Creates a shipper-to-courier payment record based on all task groups in an order. | (CreateShipperPayCourierPaymentReq) -> (PydanticObjectId)

previewV1

public java.util.concurrent.CompletableFuture<PaymentPreviewResponse> previewV1(CreateShipperPayCourierPaymentReq request)

Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierPaymentReq) -> (PaymentPreviewResponse)

previewV1

public java.util.concurrent.CompletableFuture<PaymentPreviewResponse> previewV1(CreateShipperPayCourierPaymentReq request,
                                                                                RequestOptions requestOptions)

Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierPaymentReq) -> (PaymentPreviewResponse)