Package com.chrt.api.resources.orgs.orgprofiles

Class RawOrgProfilesClient

java.lang.Object

com.chrt.api.resources.orgs.orgprofiles.RawOrgProfilesClient

public class RawOrgProfilesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawOrgProfilesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.String>	createCourierV1(CourierOrgProfileClientCreate1 request)	Creates a new courier organization profile.
ChrtApiHttpResponse<java.lang.String>	createCourierV1(CourierOrgProfileClientCreate1 request, RequestOptions requestOptions)	Creates a new courier organization profile.
ChrtApiHttpResponse<java.lang.String>	createForwarderV1(ForwarderOrgProfileClientCreate1 request)	Creates a new forwarder organization profile.
ChrtApiHttpResponse<java.lang.String>	createForwarderV1(ForwarderOrgProfileClientCreate1 request, RequestOptions requestOptions)	Creates a new forwarder organization profile.
ChrtApiHttpResponse<java.lang.String>	getAvatarV1(java.lang.String handle)	Returns the organization avatar image URL from Clerk or a placeholder if not found.
ChrtApiHttpResponse<java.lang.String>	getAvatarV1(java.lang.String handle, RequestOptions requestOptions)	Returns the organization avatar image URL from Clerk or a placeholder if not found.
ChrtApiHttpResponse<OrgProfileRes1>	getByHandleV1(java.lang.String handle)	Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing.
ChrtApiHttpResponse<OrgProfileRes1>	getByHandleV1(java.lang.String handle, RequestOptions requestOptions)	Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing.
ChrtApiHttpResponse<OrgProfileRes1>	getV1()	Retrieves the courier or forwarder organization profile for the caller's organization.
ChrtApiHttpResponse<OrgProfileRes1>	getV1(RequestOptions requestOptions)	Retrieves the courier or forwarder organization profile for the caller's organization.
ChrtApiHttpResponse<java.lang.Boolean>	updateCourierV1()	Updates an existing courier organization profile.
ChrtApiHttpResponse<java.lang.Boolean>	updateCourierV1(CourierOrgProfileClientUpdate1 request)	Updates an existing courier organization profile.
ChrtApiHttpResponse<java.lang.Boolean>	updateCourierV1(CourierOrgProfileClientUpdate1 request, RequestOptions requestOptions)	Updates an existing courier organization profile.
ChrtApiHttpResponse<java.lang.Boolean>	updateForwarderV1()	Updates an existing forwarder organization profile.
ChrtApiHttpResponse<java.lang.Boolean>	updateForwarderV1(ForwarderOrgProfileClientUpdate1 request)	Updates an existing forwarder organization profile.
ChrtApiHttpResponse<java.lang.Boolean>	updateForwarderV1(ForwarderOrgProfileClientUpdate1 request, RequestOptions requestOptions)	Updates an existing forwarder organization profile.

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

RawOrgProfilesClient

public RawOrgProfilesClient(ClientOptions clientOptions)

Method Detail

getV1

public ChrtApiHttpResponse<OrgProfileRes1> getV1()

Retrieves the courier or forwarder organization profile for the caller's organization. | () -> (OrgProfileRes1)

getV1

public ChrtApiHttpResponse<OrgProfileRes1> getV1(RequestOptions requestOptions)

Retrieves the courier or forwarder organization profile for the caller's organization. | () -> (OrgProfileRes1)

createCourierV1

public ChrtApiHttpResponse<java.lang.String> createCourierV1(CourierOrgProfileClientCreate1 request)

Creates a new courier organization profile. Fails if a profile already exists for the organization. | (CourierOrgProfileClientCreate1) -> (PydanticObjectId)

createCourierV1

public ChrtApiHttpResponse<java.lang.String> createCourierV1(CourierOrgProfileClientCreate1 request,
                                                             RequestOptions requestOptions)

Creates a new courier organization profile. Fails if a profile already exists for the organization. | (CourierOrgProfileClientCreate1) -> (PydanticObjectId)

createForwarderV1

public ChrtApiHttpResponse<java.lang.String> createForwarderV1(ForwarderOrgProfileClientCreate1 request)

Creates a new forwarder organization profile. Fails if a profile already exists for the organization. | (ForwarderOrgProfileClientCreate1) -> (PydanticObjectId)

createForwarderV1

public ChrtApiHttpResponse<java.lang.String> createForwarderV1(ForwarderOrgProfileClientCreate1 request,
                                                               RequestOptions requestOptions)

Creates a new forwarder organization profile. Fails if a profile already exists for the organization. | (ForwarderOrgProfileClientCreate1) -> (PydanticObjectId)

updateCourierV1

public ChrtApiHttpResponse<java.lang.Boolean> updateCourierV1()

Updates an existing courier organization profile. Can update one or more fields. | (CourierOrgProfileClientUpdate1) -> (bool)

updateCourierV1

public ChrtApiHttpResponse<java.lang.Boolean> updateCourierV1(CourierOrgProfileClientUpdate1 request)

Updates an existing courier organization profile. Can update one or more fields. | (CourierOrgProfileClientUpdate1) -> (bool)

updateCourierV1

public ChrtApiHttpResponse<java.lang.Boolean> updateCourierV1(CourierOrgProfileClientUpdate1 request,
                                                              RequestOptions requestOptions)

Updates an existing courier organization profile. Can update one or more fields. | (CourierOrgProfileClientUpdate1) -> (bool)

updateForwarderV1

public ChrtApiHttpResponse<java.lang.Boolean> updateForwarderV1()

Updates an existing forwarder organization profile. Can update one or more fields. | (ForwarderOrgProfileClientUpdate1) -> (bool)

updateForwarderV1

public ChrtApiHttpResponse<java.lang.Boolean> updateForwarderV1(ForwarderOrgProfileClientUpdate1 request)

Updates an existing forwarder organization profile. Can update one or more fields. | (ForwarderOrgProfileClientUpdate1) -> (bool)

updateForwarderV1

public ChrtApiHttpResponse<java.lang.Boolean> updateForwarderV1(ForwarderOrgProfileClientUpdate1 request,
                                                                RequestOptions requestOptions)

Updates an existing forwarder organization profile. Can update one or more fields. | (ForwarderOrgProfileClientUpdate1) -> (bool)

getByHandleV1

public ChrtApiHttpResponse<OrgProfileRes1> getByHandleV1(java.lang.String handle)

Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing. | () -> (OrgProfileRes1)

getByHandleV1

public ChrtApiHttpResponse<OrgProfileRes1> getByHandleV1(java.lang.String handle,
                                                         RequestOptions requestOptions)

Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing. | () -> (OrgProfileRes1)

getAvatarV1

public ChrtApiHttpResponse<java.lang.String> getAvatarV1(java.lang.String handle)

Returns the organization avatar image URL from Clerk or a placeholder if not found. | () -> (str)

getAvatarV1

public ChrtApiHttpResponse<java.lang.String> getAvatarV1(java.lang.String handle,
                                                         RequestOptions requestOptions)

Returns the organization avatar image URL from Clerk or a placeholder if not found. | () -> (str)