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

Class ConnectionsClient

java.lang.Object

com.chrt.api.resources.orgs.connections.ConnectionsClient

public class ConnectionsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ConnectionsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	createConnectionToProviderV1(CreateConnectionReq request)	Creates a new connection to a provider organization.
java.lang.String	createConnectionToProviderV1(CreateConnectionReq request, RequestOptions requestOptions)	Creates a new connection to a provider organization.
java.lang.String	createConnectionToShipperV1(CreateConnectionReq request)	Creates a new connection to a shipper organization.
java.lang.String	createConnectionToShipperV1(CreateConnectionReq request, RequestOptions requestOptions)	Creates a new connection to a shipper organization.
java.util.Optional<ConnectionsGetByHandleV1Response>	getByHandleV1(java.lang.String handle)	Gets the connection between caller's org and the org with the specified handle.
java.util.Optional<ConnectionsGetByHandleV1Response>	getByHandleV1(java.lang.String handle, RequestOptions requestOptions)	Gets the connection between caller's org and the org with the specified handle.
ProviderConnectionListRes	listProvidersV1()	Lists provider organizations connected to the caller.
ProviderConnectionListRes	listProvidersV1(ConnectionsListProvidersV1Request request)	Lists provider organizations connected to the caller.
ProviderConnectionListRes	listProvidersV1(ConnectionsListProvidersV1Request request, RequestOptions requestOptions)	Lists provider organizations connected to the caller.
ShipperConnectionListRes	listShippersV1()	Lists shipper organizations connected to the caller (caller must be a provider) with optional search by company name or handle.
ShipperConnectionListRes	listShippersV1(ConnectionsListShippersV1Request request)	Lists shipper organizations connected to the caller (caller must be a provider) with optional search by company name or handle.
ShipperConnectionListRes	listShippersV1(ConnectionsListShippersV1Request request, RequestOptions requestOptions)	Lists shipper organizations connected to the caller (caller must be a provider) with optional search by company name or handle.
boolean	setProviderProviderAutoAssignV1(java.lang.String connectionId, ProviderProviderUpdateAutoAssignReq request)	Toggles auto_assign_enabled on a provider-provider connection — the executor org's opt-in for receiving direct (non-bidding) task-group assignments.
boolean	setProviderProviderAutoAssignV1(java.lang.String connectionId, ProviderProviderUpdateAutoAssignReq request, RequestOptions requestOptions)	Toggles auto_assign_enabled on a provider-provider connection — the executor org's opt-in for receiving direct (non-bidding) task-group assignments.
RawConnectionsClient	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

ConnectionsClient

public ConnectionsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawConnectionsClient withRawResponse()

Get responses with HTTP metadata like headers

listShippersV1

public ShipperConnectionListRes listShippersV1()

Lists shipper organizations connected to the caller (caller must be a provider) with optional search by company name or handle. | () -> (ShipperConnectionListRes)

listShippersV1

public ShipperConnectionListRes listShippersV1(ConnectionsListShippersV1Request request)

Lists shipper organizations connected to the caller (caller must be a provider) with optional search by company name or handle. | () -> (ShipperConnectionListRes)

listShippersV1

public ShipperConnectionListRes listShippersV1(ConnectionsListShippersV1Request request,
                                               RequestOptions requestOptions)

Lists shipper organizations connected to the caller (caller must be a provider) with optional search by company name or handle. | () -> (ShipperConnectionListRes)

listProvidersV1

public ProviderConnectionListRes listProvidersV1()

Lists provider organizations connected to the caller. Shippers see providers from shipper_provider_connections; providers see other providers from provider_provider_connections (in either direction). | () -> (ProviderConnectionListRes)

listProvidersV1

public ProviderConnectionListRes listProvidersV1(ConnectionsListProvidersV1Request request)

Lists provider organizations connected to the caller. Shippers see providers from shipper_provider_connections; providers see other providers from provider_provider_connections (in either direction). | () -> (ProviderConnectionListRes)

listProvidersV1

public ProviderConnectionListRes listProvidersV1(ConnectionsListProvidersV1Request request,
                                                 RequestOptions requestOptions)

Lists provider organizations connected to the caller. Shippers see providers from shipper_provider_connections; providers see other providers from provider_provider_connections (in either direction). | () -> (ProviderConnectionListRes)

getByHandleV1

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

Gets the connection between caller's org and the org with the specified handle. | () -> (ShipperProviderConnection1 | ProviderProviderConnection1 | None)

getByHandleV1

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

Gets the connection between caller's org and the org with the specified handle. | () -> (ShipperProviderConnection1 | ProviderProviderConnection1 | None)

createConnectionToProviderV1

public java.lang.String createConnectionToProviderV1(CreateConnectionReq request)

Creates a new connection to a provider organization. Shippers create a shipper-provider connection. Providers create a provider-provider connection where the initiator is the coordinator (payer) and the target is the executor (payee). | (CreateConnectionReq) -> (PydanticObjectId)

createConnectionToProviderV1

public java.lang.String createConnectionToProviderV1(CreateConnectionReq request,
                                                     RequestOptions requestOptions)

Creates a new connection to a provider organization. Shippers create a shipper-provider connection. Providers create a provider-provider connection where the initiator is the coordinator (payer) and the target is the executor (payee). | (CreateConnectionReq) -> (PydanticObjectId)

createConnectionToShipperV1

public java.lang.String createConnectionToShipperV1(CreateConnectionReq request)

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

createConnectionToShipperV1

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

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

setProviderProviderAutoAssignV1

public boolean setProviderProviderAutoAssignV1(java.lang.String connectionId,
                                               ProviderProviderUpdateAutoAssignReq request)

Toggles auto_assign_enabled on a provider-provider connection — the executor org's opt-in for receiving direct (non-bidding) task-group assignments. Executor org only, min role: administrator. | (ProviderProviderUpdateAutoAssignReq) -> (bool)

setProviderProviderAutoAssignV1

public boolean setProviderProviderAutoAssignV1(java.lang.String connectionId,
                                               ProviderProviderUpdateAutoAssignReq request,
                                               RequestOptions requestOptions)

Toggles auto_assign_enabled on a provider-provider connection — the executor org's opt-in for receiving direct (non-bidding) task-group assignments. Executor org only, min role: administrator. | (ProviderProviderUpdateAutoAssignReq) -> (bool)