Package com.chrt.api.resources.shippercontactinfo

Class ShipperContactInfoClient

java.lang.Object

com.chrt.api.resources.shippercontactinfo.ShipperContactInfoClient

public class ShipperContactInfoClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ShipperContactInfoClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	createOffPlatformV1(ShipperContactClientCreate1 request)	Creates contact information for an off-platform shipper using connection info.
java.lang.String	createOffPlatformV1(ShipperContactClientCreate1 request, RequestOptions requestOptions)	Creates contact information for an off-platform shipper using connection info.
java.lang.String	createOnPlatformV1(ShipperContactClientCreate1 request)	Creates contact information for an on-platform shipper organization or user.
java.lang.String	createOnPlatformV1(ShipperContactClientCreate1 request, RequestOptions requestOptions)	Creates contact information for an on-platform shipper organization or user.
boolean	deleteV1(java.lang.String id)	Deletes shipper contact information owned by the caller's organization.
boolean	deleteV1(java.lang.String id, RequestOptions requestOptions)	Deletes shipper contact information owned by the caller's organization.
ShipperContact1	getCallerV1()	Retrieves the shipper contact information associated with the caller's ID.
ShipperContact1	getCallerV1(RequestOptions requestOptions)	Retrieves the shipper contact information associated with the caller's ID.
ShipperContact1	getV1(java.lang.String id)	Retrieves a specific shipper contact by ID if authorized to access it.
ShipperContact1	getV1(java.lang.String id, RequestOptions requestOptions)	Retrieves a specific shipper contact by ID if authorized to access it.
java.util.List<ShipperContact1>	listCourierContactsV1(java.lang.String shipperOrgId)	Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
java.util.List<ShipperContact1>	listCourierContactsV1(java.lang.String shipperOrgId, RequestOptions requestOptions)	Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
java.util.List<ShipperContact1>	listForwarderContactsV1(java.lang.String shipperOrgId)	Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper.
java.util.List<ShipperContact1>	listForwarderContactsV1(java.lang.String shipperOrgId, RequestOptions requestOptions)	Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper.
java.util.List<ShipperContact1>	listOffPlatformContactsV1(java.lang.String offChrtShipperOrgId)	Lists all shipper contacts for a specific off-platform shipper.
java.util.List<ShipperContact1>	listOffPlatformContactsV1(java.lang.String offChrtShipperOrgId, RequestOptions requestOptions)	Lists all shipper contacts for a specific off-platform shipper.
java.util.List<ShipperContact1>	listV1()	Lists all shipper contacts for the caller's organization.
java.util.List<ShipperContact1>	listV1(RequestOptions requestOptions)	Lists all shipper contacts for the caller's organization.
boolean	updateV1(java.lang.String shipperContactInfoId)	Updates existing shipper contact information owned by the caller's organization.
boolean	updateV1(java.lang.String shipperContactInfoId, ShipperContactClientUpdate1 request)	Updates existing shipper contact information owned by the caller's organization.
boolean	updateV1(java.lang.String shipperContactInfoId, ShipperContactClientUpdate1 request, RequestOptions requestOptions)	Updates existing shipper contact information owned by the caller's organization.
RawShipperContactInfoClient	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

ShipperContactInfoClient

public ShipperContactInfoClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawShipperContactInfoClient withRawResponse()

Get responses with HTTP metadata like headers

getCallerV1

public ShipperContact1 getCallerV1()

Retrieves the shipper contact information associated with the caller's ID. | () -> (ShipperContact1)

getCallerV1

public ShipperContact1 getCallerV1(RequestOptions requestOptions)

Retrieves the shipper contact information associated with the caller's ID. | () -> (ShipperContact1)

listV1

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

Lists all shipper contacts for the caller's organization. | () -> (list[ShipperContact1])

listV1

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

Lists all shipper contacts for the caller's organization. | () -> (list[ShipperContact1])

listCourierContactsV1

public java.util.List<ShipperContact1> listCourierContactsV1(java.lang.String shipperOrgId)

Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])

listCourierContactsV1

public java.util.List<ShipperContact1> listCourierContactsV1(java.lang.String shipperOrgId,
                                                             RequestOptions requestOptions)

Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])

listForwarderContactsV1

public java.util.List<ShipperContact1> listForwarderContactsV1(java.lang.String shipperOrgId)

Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper. | () -> (list[ShipperContact1])

listForwarderContactsV1

public java.util.List<ShipperContact1> listForwarderContactsV1(java.lang.String shipperOrgId,
                                                               RequestOptions requestOptions)

Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper. | () -> (list[ShipperContact1])

listOffPlatformContactsV1

public java.util.List<ShipperContact1> listOffPlatformContactsV1(java.lang.String offChrtShipperOrgId)

Lists all shipper contacts for a specific off-platform shipper. | () -> (list[ShipperContact1])

listOffPlatformContactsV1

public java.util.List<ShipperContact1> listOffPlatformContactsV1(java.lang.String offChrtShipperOrgId,
                                                                 RequestOptions requestOptions)

Lists all shipper contacts for a specific off-platform shipper. | () -> (list[ShipperContact1])

getV1

public ShipperContact1 getV1(java.lang.String id)

Retrieves a specific shipper contact by ID if authorized to access it. | () -> (ShipperContact1)

getV1

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

Retrieves a specific shipper contact by ID if authorized to access it. | () -> (ShipperContact1)

createOnPlatformV1

public java.lang.String createOnPlatformV1(ShipperContactClientCreate1 request)

Creates contact information for an on-platform shipper organization or user. | (ShipperContactClientCreate1) -> (PydanticObjectId)

createOnPlatformV1

public java.lang.String createOnPlatformV1(ShipperContactClientCreate1 request,
                                           RequestOptions requestOptions)

Creates contact information for an on-platform shipper organization or user. | (ShipperContactClientCreate1) -> (PydanticObjectId)

createOffPlatformV1

public java.lang.String createOffPlatformV1(ShipperContactClientCreate1 request)

Creates contact information for an off-platform shipper using connection info. | (ShipperContactClientCreate1) -> (PydanticObjectId)

createOffPlatformV1

public java.lang.String createOffPlatformV1(ShipperContactClientCreate1 request,
                                            RequestOptions requestOptions)

Creates contact information for an off-platform shipper using connection info. | (ShipperContactClientCreate1) -> (PydanticObjectId)

updateV1

public boolean updateV1(java.lang.String shipperContactInfoId)

Updates existing shipper contact information owned by the caller's organization. | (ShipperContactClientUpdate1) -> (bool)

updateV1

public boolean updateV1(java.lang.String shipperContactInfoId,
                        ShipperContactClientUpdate1 request)

Updates existing shipper contact information owned by the caller's organization. | (ShipperContactClientUpdate1) -> (bool)

updateV1

public boolean updateV1(java.lang.String shipperContactInfoId,
                        ShipperContactClientUpdate1 request,
                        RequestOptions requestOptions)

Updates existing shipper contact information owned by the caller's organization. | (ShipperContactClientUpdate1) -> (bool)

deleteV1

public boolean deleteV1(java.lang.String id)

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

deleteV1

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

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