Package com.chrt.api.resources.orgs.offchrtshipperorg

Class OffChrtShipperOrgClient

java.lang.Object

com.chrt.api.resources.orgs.offchrtshipperorg.OffChrtShipperOrgClient

public class OffChrtShipperOrgClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
OffChrtShipperOrgClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	createV1(OffChrtShipperOrgClientCreate1 request)	Creates an off-platform shipper organization record.
java.lang.String	createV1(OffChrtShipperOrgClientCreate1 request, RequestOptions requestOptions)	Creates an off-platform shipper organization record.
boolean	deleteByIdV1(java.lang.String id)	Deletes off-platform shipper organization owned by the caller's organization.
boolean	deleteByIdV1(java.lang.String id, RequestOptions requestOptions)	Deletes off-platform shipper organization owned by the caller's organization.
OffChrtShipperOrg1	getByIdV1(java.lang.String id)	Retrieves specific off-platform shipper organization by ID.
OffChrtShipperOrg1	getByIdV1(java.lang.String id, RequestOptions requestOptions)	Retrieves specific off-platform shipper organization by ID.
java.util.List<OffChrtShipperOrg1>	listV1()	Lists all off-platform shipper organizations created by the caller's organization.
java.util.List<OffChrtShipperOrg1>	listV1(RequestOptions requestOptions)	Lists all off-platform shipper organizations created by the caller's organization.
boolean	updateByIdV1(java.lang.String id)	Updates existing off-platform shipper organization owned by the caller's organization.
boolean	updateByIdV1(java.lang.String id, OffChrtShipperOrgClientUpdate1 request)	Updates existing off-platform shipper organization owned by the caller's organization.
boolean	updateByIdV1(java.lang.String id, OffChrtShipperOrgClientUpdate1 request, RequestOptions requestOptions)	Updates existing off-platform shipper organization owned by the caller's organization.
RawOffChrtShipperOrgClient	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

OffChrtShipperOrgClient

public OffChrtShipperOrgClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawOffChrtShipperOrgClient withRawResponse()

Get responses with HTTP metadata like headers

createV1

public java.lang.String createV1(OffChrtShipperOrgClientCreate1 request)

Creates an off-platform shipper organization record. | (OffChrtShipperOrgClientCreate1) -> (PydanticObjectId)

createV1

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

Creates an off-platform shipper organization record. | (OffChrtShipperOrgClientCreate1) -> (PydanticObjectId)

listV1

public java.util.List<OffChrtShipperOrg1> listV1()

Lists all off-platform shipper organizations created by the caller's organization. | () -> (list[OffChrtShipperOrg1])

listV1

public java.util.List<OffChrtShipperOrg1> listV1(RequestOptions requestOptions)

Lists all off-platform shipper organizations created by the caller's organization. | () -> (list[OffChrtShipperOrg1])

getByIdV1

public OffChrtShipperOrg1 getByIdV1(java.lang.String id)

Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShipperOrg1)

getByIdV1

public OffChrtShipperOrg1 getByIdV1(java.lang.String id,
                                    RequestOptions requestOptions)

Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShipperOrg1)

deleteByIdV1

public boolean deleteByIdV1(java.lang.String id)

Deletes off-platform shipper organization owned by the caller's organization. | () -> (bool)

deleteByIdV1

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

Deletes off-platform shipper organization owned by the caller's organization. | () -> (bool)

updateByIdV1

public boolean updateByIdV1(java.lang.String id)

Updates existing off-platform shipper organization owned by the caller's organization. | (OffChrtShipperOrgClientUpdate1) -> (bool)

updateByIdV1

public boolean updateByIdV1(java.lang.String id,
                            OffChrtShipperOrgClientUpdate1 request)

Updates existing off-platform shipper organization owned by the caller's organization. | (OffChrtShipperOrgClientUpdate1) -> (bool)

updateByIdV1

public boolean updateByIdV1(java.lang.String id,
                            OffChrtShipperOrgClientUpdate1 request,
                            RequestOptions requestOptions)

Updates existing off-platform shipper organization owned by the caller's organization. | (OffChrtShipperOrgClientUpdate1) -> (bool)