Package com.chrt.api.resources.orgprofiles

Class OrgProfilesClient

java.lang.Object

com.chrt.api.resources.orgprofiles.OrgProfilesClient

public class OrgProfilesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
OrgProfilesClient(ClientOptions clientOptions)

Method Summary

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

OrgProfilesClient

public OrgProfilesClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawOrgProfilesClient withRawResponse()

Get responses with HTTP metadata like headers

getV1

public OrgProfileRes1 getV1()

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

getV1

public OrgProfileRes1 getV1(RequestOptions requestOptions)

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

createCourierV1

public 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 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 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 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 boolean updateCourierV1()

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

updateCourierV1

public boolean updateCourierV1(CourierOrgProfileClientUpdate1 request)

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

updateCourierV1

public boolean updateCourierV1(CourierOrgProfileClientUpdate1 request,
                               RequestOptions requestOptions)

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

updateForwarderV1

public boolean updateForwarderV1()

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

updateForwarderV1

public boolean updateForwarderV1(ForwarderOrgProfileClientUpdate1 request)

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

updateForwarderV1

public boolean updateForwarderV1(ForwarderOrgProfileClientUpdate1 request,
                                 RequestOptions requestOptions)

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

getByHandleV1

public 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 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 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 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)