Package com.chrt.api.resources.billing.ratesheets

Class RawRateSheetsClient

java.lang.Object

com.chrt.api.resources.billing.ratesheets.RawRateSheetsClient

public class RawRateSheetsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawRateSheetsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.Boolean>	archiveV1(java.lang.String rateSheetId, RateSheetsArchiveV1Request request)	Archives or unarchives a rate sheet.
ChrtApiHttpResponse<java.lang.Boolean>	archiveV1(java.lang.String rateSheetId, RateSheetsArchiveV1Request request, RequestOptions requestOptions)	Archives or unarchives a rate sheet.
ChrtApiHttpResponse<java.lang.String>	createV1(RateSheetClientCreate1 request)	Creates a rate sheet.
ChrtApiHttpResponse<java.lang.String>	createV1(RateSheetClientCreate1 request, RequestOptions requestOptions)	Creates a rate sheet.
ChrtApiHttpResponse<RateSheet1>	getV1(java.lang.String rateSheetId)	Retrieves a rate sheet by ID.
ChrtApiHttpResponse<RateSheet1>	getV1(java.lang.String rateSheetId, RequestOptions requestOptions)	Retrieves a rate sheet by ID.
ChrtApiHttpResponse<RateSheetListResponse>	listByOrgV1()	Lists rate sheets for the caller's organization with filtering, sorting, and pagination.
ChrtApiHttpResponse<RateSheetListResponse>	listByOrgV1(RateSheetsListByOrgV1Request request)	Lists rate sheets for the caller's organization with filtering, sorting, and pagination.
ChrtApiHttpResponse<RateSheetListResponse>	listByOrgV1(RateSheetsListByOrgV1Request request, RequestOptions requestOptions)	Lists rate sheets for the caller's organization with filtering, sorting, and pagination.
ChrtApiHttpResponse<java.lang.Boolean>	updateDefaultForConnectionV1(RateSheetsUpdateDefaultForConnectionV1Request request)	Sets or clears a rate sheet as the default for a connection.
ChrtApiHttpResponse<java.lang.Boolean>	updateDefaultForConnectionV1(RateSheetsUpdateDefaultForConnectionV1Request request, RequestOptions requestOptions)	Sets or clears a rate sheet as the default for a connection.
ChrtApiHttpResponse<java.lang.Boolean>	updateDefaultForDriverV1(RateSheetsUpdateDefaultForDriverV1Request request)	Sets or clears a rate sheet as the default for a driver.
ChrtApiHttpResponse<java.lang.Boolean>	updateDefaultForDriverV1(RateSheetsUpdateDefaultForDriverV1Request request, RequestOptions requestOptions)	Sets or clears a rate sheet as the default for a driver.
ChrtApiHttpResponse<java.lang.Boolean>	updateDefaultForOffChrtShipperV1(RateSheetsUpdateDefaultForOffChrtShipperV1Request request)	Sets or clears a rate sheet as the default for an off-chrt shipper.
ChrtApiHttpResponse<java.lang.Boolean>	updateDefaultForOffChrtShipperV1(RateSheetsUpdateDefaultForOffChrtShipperV1Request request, RequestOptions requestOptions)	Sets or clears a rate sheet as the default for an off-chrt shipper.
ChrtApiHttpResponse<java.lang.Boolean>	updateOrgDefaultForServiceTypeV1(RateSheetsUpdateOrgDefaultForServiceTypeV1Request request)	Sets or clears the org's default rate sheet for a payment vector type and service type.
ChrtApiHttpResponse<java.lang.Boolean>	updateOrgDefaultForServiceTypeV1(RateSheetsUpdateOrgDefaultForServiceTypeV1Request request, RequestOptions requestOptions)	Sets or clears the org's default rate sheet for a payment vector type and service type.
ChrtApiHttpResponse<RateSheet1>	updateV1(java.lang.String rateSheetId)	Updates a rate sheet.
ChrtApiHttpResponse<RateSheet1>	updateV1(java.lang.String rateSheetId, RateSheetClientUpdate1 request)	Updates a rate sheet.
ChrtApiHttpResponse<RateSheet1>	updateV1(java.lang.String rateSheetId, RateSheetClientUpdate1 request, RequestOptions requestOptions)	Updates a rate sheet.

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

RawRateSheetsClient

public RawRateSheetsClient(ClientOptions clientOptions)

Method Detail

getV1

public ChrtApiHttpResponse<RateSheet1> getV1(java.lang.String rateSheetId)

Retrieves a rate sheet by ID. Only the owning org can fetch. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheet1)

getV1

public ChrtApiHttpResponse<RateSheet1> getV1(java.lang.String rateSheetId,
                                             RequestOptions requestOptions)

Retrieves a rate sheet by ID. Only the owning org can fetch. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheet1)

updateV1

public ChrtApiHttpResponse<RateSheet1> updateV1(java.lang.String rateSheetId)

Updates a rate sheet. Only name, comments, cargo_types, and vehicle_types can be changed. Use the archive endpoint for archiving. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientUpdate1) -> (RateSheet1)

updateV1

public ChrtApiHttpResponse<RateSheet1> updateV1(java.lang.String rateSheetId,
                                                RateSheetClientUpdate1 request)

Updates a rate sheet. Only name, comments, cargo_types, and vehicle_types can be changed. Use the archive endpoint for archiving. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientUpdate1) -> (RateSheet1)

updateV1

public ChrtApiHttpResponse<RateSheet1> updateV1(java.lang.String rateSheetId,
                                                RateSheetClientUpdate1 request,
                                                RequestOptions requestOptions)

Updates a rate sheet. Only name, comments, cargo_types, and vehicle_types can be changed. Use the archive endpoint for archiving. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientUpdate1) -> (RateSheet1)

listByOrgV1

public ChrtApiHttpResponse<RateSheetListResponse> listByOrgV1()

Lists rate sheets for the caller's organization with filtering, sorting, and pagination. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheetListResponse)

listByOrgV1

public ChrtApiHttpResponse<RateSheetListResponse> listByOrgV1(RateSheetsListByOrgV1Request request)

Lists rate sheets for the caller's organization with filtering, sorting, and pagination. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheetListResponse)

listByOrgV1

public ChrtApiHttpResponse<RateSheetListResponse> listByOrgV1(RateSheetsListByOrgV1Request request,
                                                              RequestOptions requestOptions)

Lists rate sheets for the caller's organization with filtering, sorting, and pagination. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheetListResponse)

createV1

public ChrtApiHttpResponse<java.lang.String> createV1(RateSheetClientCreate1 request)

Creates a rate sheet. Couriers and forwarders only. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientCreate1) -> (PydanticObjectId)

createV1

public ChrtApiHttpResponse<java.lang.String> createV1(RateSheetClientCreate1 request,
                                                      RequestOptions requestOptions)

Creates a rate sheet. Couriers and forwarders only. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientCreate1) -> (PydanticObjectId)

archiveV1

public ChrtApiHttpResponse<java.lang.Boolean> archiveV1(java.lang.String rateSheetId,
                                                        RateSheetsArchiveV1Request request)

Archives or unarchives a rate sheet. When archiving, automatically removes the rate sheet from all default assignments (OrgPrivateData, Connections, Drivers). | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)

archiveV1

public ChrtApiHttpResponse<java.lang.Boolean> archiveV1(java.lang.String rateSheetId,
                                                        RateSheetsArchiveV1Request request,
                                                        RequestOptions requestOptions)

Archives or unarchives a rate sheet. When archiving, automatically removes the rate sheet from all default assignments (OrgPrivateData, Connections, Drivers). | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)

updateOrgDefaultForServiceTypeV1

public ChrtApiHttpResponse<java.lang.Boolean> updateOrgDefaultForServiceTypeV1(RateSheetsUpdateOrgDefaultForServiceTypeV1Request request)

Sets or clears the org's default rate sheet for a payment vector type and service type. Pass rate_sheet_id to set a default, or omit it to clear the default. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)

updateOrgDefaultForServiceTypeV1

public ChrtApiHttpResponse<java.lang.Boolean> updateOrgDefaultForServiceTypeV1(RateSheetsUpdateOrgDefaultForServiceTypeV1Request request,
                                                                               RequestOptions requestOptions)

Sets or clears the org's default rate sheet for a payment vector type and service type. Pass rate_sheet_id to set a default, or omit it to clear the default. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)

updateDefaultForConnectionV1

public ChrtApiHttpResponse<java.lang.Boolean> updateDefaultForConnectionV1(RateSheetsUpdateDefaultForConnectionV1Request request)

Sets or clears a rate sheet as the default for a connection. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per connection. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)

updateDefaultForConnectionV1

public ChrtApiHttpResponse<java.lang.Boolean> updateDefaultForConnectionV1(RateSheetsUpdateDefaultForConnectionV1Request request,
                                                                           RequestOptions requestOptions)

Sets or clears a rate sheet as the default for a connection. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per connection. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)

updateDefaultForDriverV1

public ChrtApiHttpResponse<java.lang.Boolean> updateDefaultForDriverV1(RateSheetsUpdateDefaultForDriverV1Request request)

Sets or clears a rate sheet as the default for a driver. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per driver. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)

updateDefaultForDriverV1

public ChrtApiHttpResponse<java.lang.Boolean> updateDefaultForDriverV1(RateSheetsUpdateDefaultForDriverV1Request request,
                                                                       RequestOptions requestOptions)

Sets or clears a rate sheet as the default for a driver. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per driver. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)

updateDefaultForOffChrtShipperV1

public ChrtApiHttpResponse<java.lang.Boolean> updateDefaultForOffChrtShipperV1(RateSheetsUpdateDefaultForOffChrtShipperV1Request request)

Sets or clears a rate sheet as the default for an off-chrt shipper. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per off-chrt shipper. | authz: allowed_org_types=[courier], min_org_role=operator | () -> (bool)

updateDefaultForOffChrtShipperV1

public ChrtApiHttpResponse<java.lang.Boolean> updateDefaultForOffChrtShipperV1(RateSheetsUpdateDefaultForOffChrtShipperV1Request request,
                                                                               RequestOptions requestOptions)

Sets or clears a rate sheet as the default for an off-chrt shipper. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per off-chrt shipper. | authz: allowed_org_types=[courier], min_org_role=operator | () -> (bool)