Package com.chrt.api.resources.shippercontactinfo

Class RawShipperContactInfoClient

java.lang.Object

com.chrt.api.resources.shippercontactinfo.RawShipperContactInfoClient

public class RawShipperContactInfoClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawShipperContactInfoClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.String>	createOffPlatformV1(ShipperContactClientCreate1 request)	Creates contact information for an off-platform shipper using connection info.
ChrtApiHttpResponse<java.lang.String>	createOffPlatformV1(ShipperContactClientCreate1 request, RequestOptions requestOptions)	Creates contact information for an off-platform shipper using connection info.
ChrtApiHttpResponse<java.lang.String>	createOnPlatformV1(ShipperContactClientCreate1 request)	Creates contact information for an on-platform shipper organization or user.
ChrtApiHttpResponse<java.lang.String>	createOnPlatformV1(ShipperContactClientCreate1 request, RequestOptions requestOptions)	Creates contact information for an on-platform shipper organization or user.
ChrtApiHttpResponse<java.lang.Boolean>	deleteByIdV1(java.lang.String id)	Deletes shipper contact information owned by the authenticated organization.
ChrtApiHttpResponse<java.lang.Boolean>	deleteByIdV1(java.lang.String id, RequestOptions requestOptions)	Deletes shipper contact information owned by the authenticated organization.
ChrtApiHttpResponse<ShipperContact1>	getByIdV1(java.lang.String id)	Retrieves a specific shipper contact by ID if authorized to access it.
ChrtApiHttpResponse<ShipperContact1>	getByIdV1(java.lang.String id, RequestOptions requestOptions)	Retrieves a specific shipper contact by ID if authorized to access it.
ChrtApiHttpResponse<ShipperContact1>	getByJwtUserIdV1()	Retrieves the authenticated user's own shipper contact information.
ChrtApiHttpResponse<ShipperContact1>	getByJwtUserIdV1(RequestOptions requestOptions)	Retrieves the authenticated user's own shipper contact information.
ChrtApiHttpResponse<java.util.List<ShipperContact1>>	listByJwtOrgIdV1()	Lists all shipper contacts created by the authenticated organization.
ChrtApiHttpResponse<java.util.List<ShipperContact1>>	listByJwtOrgIdV1(RequestOptions requestOptions)	Lists all shipper contacts created by the authenticated organization.
ChrtApiHttpResponse<java.util.List<ShipperContact1>>	listByOffChrtShipperOrgIdV1(java.lang.String offChrtShipperOrgId)	Lists all shipper contacts for a specific off-platform shipper connection.
ChrtApiHttpResponse<java.util.List<ShipperContact1>>	listByOffChrtShipperOrgIdV1(java.lang.String offChrtShipperOrgId, RequestOptions requestOptions)	Lists all shipper contacts for a specific off-platform shipper connection.
ChrtApiHttpResponse<java.util.List<ShipperContact1>>	listCourierContactsByShipperOrgIdV1(java.lang.String shipperOrgId)	Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
ChrtApiHttpResponse<java.util.List<ShipperContact1>>	listCourierContactsByShipperOrgIdV1(java.lang.String shipperOrgId, RequestOptions requestOptions)	Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
ChrtApiHttpResponse<java.lang.Boolean>	updateV1(java.lang.String shipperContactInfoId)	Updates existing shipper contact information owned by the authenticated organization.
ChrtApiHttpResponse<java.lang.Boolean>	updateV1(java.lang.String shipperContactInfoId, ShipperContactClientUpdate1 request)	Updates existing shipper contact information owned by the authenticated organization.
ChrtApiHttpResponse<java.lang.Boolean>	updateV1(java.lang.String shipperContactInfoId, ShipperContactClientUpdate1 request, RequestOptions requestOptions)	Updates existing shipper contact information owned by the authenticated organization.

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

RawShipperContactInfoClient

public RawShipperContactInfoClient(ClientOptions clientOptions)

Method Detail

getByJwtUserIdV1

public ChrtApiHttpResponse<ShipperContact1> getByJwtUserIdV1()

Retrieves the authenticated user's own shipper contact information.

getByJwtUserIdV1

public ChrtApiHttpResponse<ShipperContact1> getByJwtUserIdV1(RequestOptions requestOptions)

Retrieves the authenticated user's own shipper contact information.

listByJwtOrgIdV1

public ChrtApiHttpResponse<java.util.List<ShipperContact1>> listByJwtOrgIdV1()

Lists all shipper contacts created by the authenticated organization.

listByJwtOrgIdV1

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

Lists all shipper contacts created by the authenticated organization.

listCourierContactsByShipperOrgIdV1

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

Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.

listCourierContactsByShipperOrgIdV1

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

Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.

listByOffChrtShipperOrgIdV1

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

Lists all shipper contacts for a specific off-platform shipper connection.

listByOffChrtShipperOrgIdV1

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

Lists all shipper contacts for a specific off-platform shipper connection.

getByIdV1

public ChrtApiHttpResponse<ShipperContact1> getByIdV1(java.lang.String id)

Retrieves a specific shipper contact by ID if authorized to access it.

getByIdV1

public ChrtApiHttpResponse<ShipperContact1> getByIdV1(java.lang.String id,
                                                      RequestOptions requestOptions)

Retrieves a specific shipper contact by ID if authorized to access it.

createOnPlatformV1

public ChrtApiHttpResponse<java.lang.String> createOnPlatformV1(ShipperContactClientCreate1 request)

Creates contact information for an on-platform shipper organization or user.

createOnPlatformV1

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

Creates contact information for an on-platform shipper organization or user.

createOffPlatformV1

public ChrtApiHttpResponse<java.lang.String> createOffPlatformV1(ShipperContactClientCreate1 request)

Creates contact information for an off-platform shipper using connection info.

createOffPlatformV1

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

Creates contact information for an off-platform shipper using connection info.

updateV1

public ChrtApiHttpResponse<java.lang.Boolean> updateV1(java.lang.String shipperContactInfoId)

Updates existing shipper contact information owned by the authenticated organization.

updateV1

public ChrtApiHttpResponse<java.lang.Boolean> updateV1(java.lang.String shipperContactInfoId,
                                                       ShipperContactClientUpdate1 request)

Updates existing shipper contact information owned by the authenticated organization.

updateV1

public ChrtApiHttpResponse<java.lang.Boolean> updateV1(java.lang.String shipperContactInfoId,
                                                       ShipperContactClientUpdate1 request,
                                                       RequestOptions requestOptions)

Updates existing shipper contact information owned by the authenticated organization.

deleteByIdV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteByIdV1(java.lang.String id)

Deletes shipper contact information owned by the authenticated organization.

deleteByIdV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteByIdV1(java.lang.String id,
                                                           RequestOptions requestOptions)

Deletes shipper contact information owned by the authenticated organization.