Package com.chrt.api.resources.shipperpaycourierratesheets

Class ShipperPayCourierRateSheetsClient

java.lang.Object

com.chrt.api.resources.shipperpaycourierratesheets.ShipperPayCourierRateSheetsClient

public class ShipperPayCourierRateSheetsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ShipperPayCourierRateSheetsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	createV1(ShipperPayCourierRateSheetClientCreate1 request)	Creates a new rate sheet for a courier to charge shippers.
java.lang.String	createV1(ShipperPayCourierRateSheetClientCreate1 request, RequestOptions requestOptions)	Creates a new rate sheet for a courier to charge shippers.
boolean	deleteByIdV1(java.lang.String id)	Deletes a rate sheet owned by the authenticated courier organization.
boolean	deleteByIdV1(java.lang.String id, RequestOptions requestOptions)	Deletes a rate sheet owned by the authenticated courier organization.
ShipperPayCourierRateSheet1	getV1(java.lang.String id)	Retrieves a single rate sheet by its ID (courier access only).
ShipperPayCourierRateSheet1	getV1(java.lang.String id, RequestOptions requestOptions)	Retrieves a single rate sheet by its ID (courier access only).
java.util.List<ShipperPayCourierRateSheet1>	listByCourierOrgIdV1()	Lists all rate sheets created by the authenticated courier organization.
java.util.List<ShipperPayCourierRateSheet1>	listByCourierOrgIdV1(RequestOptions requestOptions)	Lists all rate sheets created by the authenticated courier organization.
ShipperPayCourierRateSheet1	updateByIdV1(java.lang.String id)	Updates an existing rate sheet owned by the authenticated courier organization.
ShipperPayCourierRateSheet1	updateByIdV1(java.lang.String id, ShipperPayCourierRateSheetClientUpdate1 request)	Updates an existing rate sheet owned by the authenticated courier organization.
ShipperPayCourierRateSheet1	updateByIdV1(java.lang.String id, ShipperPayCourierRateSheetClientUpdate1 request, RequestOptions requestOptions)	Updates an existing rate sheet owned by the authenticated courier organization.
RawShipperPayCourierRateSheetsClient	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

ShipperPayCourierRateSheetsClient

public ShipperPayCourierRateSheetsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawShipperPayCourierRateSheetsClient withRawResponse()

Get responses with HTTP metadata like headers

listByCourierOrgIdV1

public java.util.List<ShipperPayCourierRateSheet1> listByCourierOrgIdV1()

Lists all rate sheets created by the authenticated courier organization. | () -> (list[ShipperPayCourierRateSheet1])

listByCourierOrgIdV1

public java.util.List<ShipperPayCourierRateSheet1> listByCourierOrgIdV1(RequestOptions requestOptions)

Lists all rate sheets created by the authenticated courier organization. | () -> (list[ShipperPayCourierRateSheet1])

createV1

public java.lang.String createV1(ShipperPayCourierRateSheetClientCreate1 request)

Creates a new rate sheet for a courier to charge shippers. | (ShipperPayCourierRateSheetClientCreate1) -> (PydanticObjectId)

createV1

public java.lang.String createV1(ShipperPayCourierRateSheetClientCreate1 request,
                                 RequestOptions requestOptions)

Creates a new rate sheet for a courier to charge shippers. | (ShipperPayCourierRateSheetClientCreate1) -> (PydanticObjectId)

getV1

public ShipperPayCourierRateSheet1 getV1(java.lang.String id)

Retrieves a single rate sheet by its ID (courier access only). | () -> (ShipperPayCourierRateSheet1)

getV1

public ShipperPayCourierRateSheet1 getV1(java.lang.String id,
                                         RequestOptions requestOptions)

Retrieves a single rate sheet by its ID (courier access only). | () -> (ShipperPayCourierRateSheet1)

deleteByIdV1

public boolean deleteByIdV1(java.lang.String id)

Deletes a rate sheet owned by the authenticated courier organization. | () -> (bool)

deleteByIdV1

public boolean deleteByIdV1(java.lang.String id,
                            RequestOptions requestOptions)

Deletes a rate sheet owned by the authenticated courier organization. | () -> (bool)

updateByIdV1

public ShipperPayCourierRateSheet1 updateByIdV1(java.lang.String id)

Updates an existing rate sheet owned by the authenticated courier organization. | (ShipperPayCourierRateSheetClientUpdate1) -> (ShipperPayCourierRateSheet1)

updateByIdV1

public ShipperPayCourierRateSheet1 updateByIdV1(java.lang.String id,
                                                ShipperPayCourierRateSheetClientUpdate1 request)

Updates an existing rate sheet owned by the authenticated courier organization. | (ShipperPayCourierRateSheetClientUpdate1) -> (ShipperPayCourierRateSheet1)

updateByIdV1

public ShipperPayCourierRateSheet1 updateByIdV1(java.lang.String id,
                                                ShipperPayCourierRateSheetClientUpdate1 request,
                                                RequestOptions requestOptions)

Updates an existing rate sheet owned by the authenticated courier organization. | (ShipperPayCourierRateSheetClientUpdate1) -> (ShipperPayCourierRateSheet1)