java.lang.Object
- com.chrt.api.resources.billing.ratesheets.AsyncRateSheetsClient

public class AsyncRateSheetsClient
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field Description

protected ClientOptions clientOptions

Constructor Summary

Constructors
Constructor Description

AsyncRateSheetsClient(ClientOptions clientOptions)

Method Summary

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

AsyncRateSheetsClient

public AsyncRateSheetsClient(ClientOptions clientOptions)

Method Detail

withRawResponse
```
public AsyncRawRateSheetsClient withRawResponse()
```
Get responses with HTTP metadata like headers

getV1
```
public java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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.util.concurrent.CompletableFuture<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.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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)

Class AsyncRateSheetsClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

clientOptions

Constructor Detail

AsyncRateSheetsClient

Method Detail

withRawResponse

getV1

getV1

updateV1

updateV1

updateV1

listByOrgV1

listByOrgV1

listByOrgV1

createV1

createV1

archiveV1

archiveV1

updateOrgDefaultForServiceTypeV1

updateOrgDefaultForServiceTypeV1

updateDefaultForConnectionV1

updateDefaultForConnectionV1

updateDefaultForDriverV1

updateDefaultForDriverV1

updateDefaultForOffChrtShipperV1

updateDefaultForOffChrtShipperV1