Package com.chrt.api.resources.orginfoforconnections.courier

Class CourierClient

java.lang.Object

com.chrt.api.resources.orginfoforconnections.courier.CourierClient

public class CourierClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
CourierClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	createV1(CourierOrgInfoForConnectionsClientCreate1 request)	Creates courier organization connection information.
java.lang.String	createV1(CourierOrgInfoForConnectionsClientCreate1 request, RequestOptions requestOptions)	Creates courier organization connection information.
CourierOrgInfoForConnections1	getV1()	Retrieves courier organization connection information for the caller's organization.
CourierOrgInfoForConnections1	getV1(RequestOptions requestOptions)	Retrieves courier organization connection information for the caller's organization.
java.util.List<CourierOrgInfoForConnections1>	listV1()	Retrieves list of connected courier organizations for forwarder or shipper organizations.
java.util.List<CourierOrgInfoForConnections1>	listV1(RequestOptions requestOptions)	Retrieves list of connected courier organizations for forwarder or shipper organizations.
boolean	updateV1()	Updates existing courier organization connection information.
boolean	updateV1(CourierOrgInfoForConnectionsClientUpdate1 request)	Updates existing courier organization connection information.
boolean	updateV1(CourierOrgInfoForConnectionsClientUpdate1 request, RequestOptions requestOptions)	Updates existing courier organization connection information.
RawCourierClient	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

CourierClient

public CourierClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawCourierClient withRawResponse()

Get responses with HTTP metadata like headers

getV1

public CourierOrgInfoForConnections1 getV1()

Retrieves courier organization connection information for the caller's organization. | () -> (CourierOrgInfoForConnections1)

getV1

public CourierOrgInfoForConnections1 getV1(RequestOptions requestOptions)

Retrieves courier organization connection information for the caller's organization. | () -> (CourierOrgInfoForConnections1)

listV1

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

Retrieves list of connected courier organizations for forwarder or shipper organizations. Not accessible by courier organizations. | () -> (list[CourierOrgInfoForConnections1])

listV1

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

Retrieves list of connected courier organizations for forwarder or shipper organizations. Not accessible by courier organizations. | () -> (list[CourierOrgInfoForConnections1])

createV1

public java.lang.String createV1(CourierOrgInfoForConnectionsClientCreate1 request)

Creates courier organization connection information. Fails if already exists. | (CourierOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)

createV1

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

Creates courier organization connection information. Fails if already exists. | (CourierOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)

updateV1

public boolean updateV1()

Updates existing courier organization connection information. | (CourierOrgInfoForConnectionsClientUpdate1) -> (bool)

updateV1

public boolean updateV1(CourierOrgInfoForConnectionsClientUpdate1 request)

Updates existing courier organization connection information. | (CourierOrgInfoForConnectionsClientUpdate1) -> (bool)

updateV1

public boolean updateV1(CourierOrgInfoForConnectionsClientUpdate1 request,
                        RequestOptions requestOptions)

Updates existing courier organization connection information. | (CourierOrgInfoForConnectionsClientUpdate1) -> (bool)