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

Class RateSheetsClient

java.lang.Object

com.chrt.api.resources.billing.ratesheets.RateSheetsClient

public class RateSheetsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RateSheetsClient(ClientOptions clientOptions)

Method Summary

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

RateSheetsClient

public RateSheetsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawRateSheetsClient withRawResponse()

Get responses with HTTP metadata like headers

getV1

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