Package com.chrt.api.resources.orgs.connections

Class RawConnectionsClient

java.lang.Object

com.chrt.api.resources.orgs.connections.RawConnectionsClient

public class RawConnectionsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawConnectionsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.String>	createConnectionToCourierV1(CreateConnectionReq request)	Creates a new connection to a courier organization.
ChrtApiHttpResponse<java.lang.String>	createConnectionToCourierV1(CreateConnectionReq request, RequestOptions requestOptions)	Creates a new connection to a courier organization.
ChrtApiHttpResponse<java.lang.String>	createConnectionToForwarderV1(CreateConnectionReq request)	Creates a new connection to a forwarder organization.
ChrtApiHttpResponse<java.lang.String>	createConnectionToForwarderV1(CreateConnectionReq request, RequestOptions requestOptions)	Creates a new connection to a forwarder organization.
ChrtApiHttpResponse<java.lang.String>	createConnectionToShipperV1(CreateConnectionReq request)	Creates a new connection to a shipper organization.
ChrtApiHttpResponse<java.lang.String>	createConnectionToShipperV1(CreateConnectionReq request, RequestOptions requestOptions)	Creates a new connection to a shipper organization.
ChrtApiHttpResponse<java.util.Optional<ConnectionsGetByHandleV1Response>>	getByHandleV1(java.lang.String handle)	Gets connection between caller's org and org with specified handle.
ChrtApiHttpResponse<java.util.Optional<ConnectionsGetByHandleV1Response>>	getByHandleV1(java.lang.String handle, RequestOptions requestOptions)	Gets connection between caller's org and org with specified handle.
ChrtApiHttpResponse<java.util.List<CourierConnectionRes>>	listCouriersV1()	Lists courier organizations based on the caller's organization type.
ChrtApiHttpResponse<java.util.List<CourierConnectionRes>>	listCouriersV1(RequestOptions requestOptions)	Lists courier organizations based on the caller's organization type.
ChrtApiHttpResponse<java.util.List<ForwarderConnectionRes>>	listForwardersV1()	Lists forwarder organizations based on the caller's organization type.
ChrtApiHttpResponse<java.util.List<ForwarderConnectionRes>>	listForwardersV1(RequestOptions requestOptions)	Lists forwarder organizations based on the caller's organization type.
ChrtApiHttpResponse<java.util.List<ShipperConnectionRes>>	listShippersV1()	Lists shipper organizations based on the caller's organization type.
ChrtApiHttpResponse<java.util.List<ShipperConnectionRes>>	listShippersV1(RequestOptions requestOptions)	Lists shipper organizations based on the caller's organization type.

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

RawConnectionsClient

public RawConnectionsClient(ClientOptions clientOptions)

Method Detail

listShippersV1

public ChrtApiHttpResponse<java.util.List<ShipperConnectionRes>> listShippersV1()

Lists shipper organizations based on the caller's organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (list[ShipperConnectionRes])

listShippersV1

public ChrtApiHttpResponse<java.util.List<ShipperConnectionRes>> listShippersV1(RequestOptions requestOptions)

Lists shipper organizations based on the caller's organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (list[ShipperConnectionRes])

listCouriersV1

public ChrtApiHttpResponse<java.util.List<CourierConnectionRes>> listCouriersV1()

Lists courier organizations based on the caller's organization type. Shippers see connected couriers, forwarders see connected couriers. | () -> (list[CourierConnectionRes])

listCouriersV1

public ChrtApiHttpResponse<java.util.List<CourierConnectionRes>> listCouriersV1(RequestOptions requestOptions)

Lists courier organizations based on the caller's organization type. Shippers see connected couriers, forwarders see connected couriers. | () -> (list[CourierConnectionRes])

listForwardersV1

public ChrtApiHttpResponse<java.util.List<ForwarderConnectionRes>> listForwardersV1()

Lists forwarder organizations based on the caller's organization type. Shippers see connected forwarders, couriers see connected forwarders. | () -> (list[ForwarderConnectionRes])

listForwardersV1

public ChrtApiHttpResponse<java.util.List<ForwarderConnectionRes>> listForwardersV1(RequestOptions requestOptions)

Lists forwarder organizations based on the caller's organization type. Shippers see connected forwarders, couriers see connected forwarders. | () -> (list[ForwarderConnectionRes])

getByHandleV1

public ChrtApiHttpResponse<java.util.Optional<ConnectionsGetByHandleV1Response>> getByHandleV1(java.lang.String handle)

Gets connection between caller's org and org with specified handle. | () -> (ShipperCourierConnection1 | ShipperForwarderConnection1 | ForwarderCourierConnection1 | None)

getByHandleV1

public ChrtApiHttpResponse<java.util.Optional<ConnectionsGetByHandleV1Response>> getByHandleV1(java.lang.String handle,
                                                                                               RequestOptions requestOptions)

Gets connection between caller's org and org with specified handle. | () -> (ShipperCourierConnection1 | ShipperForwarderConnection1 | ForwarderCourierConnection1 | None)

createConnectionToCourierV1

public ChrtApiHttpResponse<java.lang.String> createConnectionToCourierV1(CreateConnectionReq request)

Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers. | (CreateConnectionReq) -> (PydanticObjectId)

createConnectionToCourierV1

public ChrtApiHttpResponse<java.lang.String> createConnectionToCourierV1(CreateConnectionReq request,
                                                                         RequestOptions requestOptions)

Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers. | (CreateConnectionReq) -> (PydanticObjectId)

createConnectionToShipperV1

public ChrtApiHttpResponse<java.lang.String> createConnectionToShipperV1(CreateConnectionReq request)

Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)

createConnectionToShipperV1

public ChrtApiHttpResponse<java.lang.String> createConnectionToShipperV1(CreateConnectionReq request,
                                                                         RequestOptions requestOptions)

Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)

createConnectionToForwarderV1

public ChrtApiHttpResponse<java.lang.String> createConnectionToForwarderV1(CreateConnectionReq request)

Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders. | (CreateConnectionReq) -> (PydanticObjectId)

createConnectionToForwarderV1

public ChrtApiHttpResponse<java.lang.String> createConnectionToForwarderV1(CreateConnectionReq request,
                                                                           RequestOptions requestOptions)

Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders. | (CreateConnectionReq) -> (PydanticObjectId)