BoxApi (usmartbox-java-client 1.0.0-bate2 API)

java.lang.Object
- cn.acey.integrate.usmartbox.client.api.BoxApi

```
public class BoxApi
extends Object
```

Constructor Summary

Constructors
Constructor and Description

BoxApi()

BoxApi(ApiClient apiClient)

Constructors
Constructor and Description
`BoxApi()`
`BoxApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiClient`	`getApiClient()`
`RemotePutInResponse`	`remotePutInBox(String apikey, String nonce, String sign, String boxno, String butype, String func, String kphone, String orderid, String phone, String size)` 远程存
`com.squareup.okhttp.Call`	`remotePutInBoxAsync(String apikey, String nonce, String sign, String boxno, String butype, String func, String kphone, String orderid, String phone, String size, ApiCallback<RemotePutInResponse> callback)` 远程存 (asynchronously)
`com.squareup.okhttp.Call`	`remotePutInBoxCall(String apikey, String nonce, String sign, String boxno, String butype, String func, String kphone, String orderid, String phone, String size, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for remotePutInBox
`RemotePutInHistoryResponse`	`remotePutInBoxHistory(String apikey, String nonce, String sign, String orderid)` 远程存
`com.squareup.okhttp.Call`	`remotePutInBoxHistoryAsync(String apikey, String nonce, String sign, String orderid, ApiCallback<RemotePutInHistoryResponse> callback)` 远程存 (asynchronously)
`com.squareup.okhttp.Call`	`remotePutInBoxHistoryCall(String apikey, String nonce, String sign, String orderid, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for remotePutInBoxHistory
`ApiResponse<RemotePutInHistoryResponse>`	`remotePutInBoxHistoryWithHttpInfo(String apikey, String nonce, String sign, String orderid)` 远程存
`ApiResponse<RemotePutInResponse>`	`remotePutInBoxWithHttpInfo(String apikey, String nonce, String sign, String boxno, String butype, String func, String kphone, String orderid, String phone, String size)` 远程存
`RemoteTakeOutResponse`	`remoteTakeOutBox(String apikey, String nonce, String sign, String gridno, String opencode, String seqid)` 远程取
`com.squareup.okhttp.Call`	`remoteTakeOutBoxAsync(String apikey, String nonce, String sign, String gridno, String opencode, String seqid, ApiCallback<RemoteTakeOutResponse> callback)` 远程取 (asynchronously)
`com.squareup.okhttp.Call`	`remoteTakeOutBoxCall(String apikey, String nonce, String sign, String gridno, String opencode, String seqid, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for remoteTakeOutBox
`ApiResponse<RemoteTakeOutResponse>`	`remoteTakeOutBoxWithHttpInfo(String apikey, String nonce, String sign, String gridno, String opencode, String seqid)` 远程取
`RemoteTakeOutResponse`	`remoteTakeOutHistory(String apikey, String nonce, String sign, String gridno, String seqid)` 查询取件状态
`com.squareup.okhttp.Call`	`remoteTakeOutHistoryAsync(String apikey, String nonce, String sign, String gridno, String seqid, ApiCallback<RemoteTakeOutResponse> callback)` 查询取件状态 (asynchronously)
`com.squareup.okhttp.Call`	`remoteTakeOutHistoryCall(String apikey, String nonce, String sign, String gridno, String seqid, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for remoteTakeOutHistory
`ApiResponse<RemoteTakeOutResponse>`	`remoteTakeOutHistoryWithHttpInfo(String apikey, String nonce, String sign, String gridno, String seqid)` 查询取件状态
`BoxSearchResponse`	`searchBox(String apikey, String nonce, String sign, String city, String district, String branchno)` 根据城市及区号及网点编号查询下属柜子
`com.squareup.okhttp.Call`	`searchBoxAsync(String apikey, String nonce, String sign, String city, String district, String branchno, ApiCallback<BoxSearchResponse> callback)` 根据城市及区号及网点编号查询下属柜子 (asynchronously)
`com.squareup.okhttp.Call`	`searchBoxCall(String apikey, String nonce, String sign, String city, String district, String branchno, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for searchBox
`ApiResponse<BoxSearchResponse>`	`searchBoxWithHttpInfo(String apikey, String nonce, String sign, String city, String district, String branchno)` 根据城市及区号及网点编号查询下属柜子
`BranchBoxSearchResponse`	`searchBranchBox(String apikey, String nonce, String sign, String city, String district)` 根据城市及区号查询下属网点及柜子
`com.squareup.okhttp.Call`	`searchBranchBoxAsync(String apikey, String nonce, String sign, String city, String district, ApiCallback<BranchBoxSearchResponse> callback)` 根据城市及区号查询下属网点及柜子 (asynchronously)
`com.squareup.okhttp.Call`	`searchBranchBoxCall(String apikey, String nonce, String sign, String city, String district, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for searchBranchBox
`ApiResponse<BranchBoxSearchResponse>`	`searchBranchBoxWithHttpInfo(String apikey, String nonce, String sign, String city, String district)` 根据城市及区号查询下属网点及柜子
`void`	`setApiClient(ApiClient apiClient)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxApi
```
public BoxApi()
```

BoxApi
```
public BoxApi(ApiClient apiClient)
```

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

remotePutInBoxCall

public com.squareup.okhttp.Call remotePutInBoxCall(String apikey,
                                                   String nonce,
                                                   String sign,
                                                   String boxno,
                                                   String butype,
                                                   String func,
                                                   String kphone,
                                                   String orderid,
                                                   String phone,
                                                   String size,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for remotePutInBox

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); boxno - 柜子编号 (optional); butype - 业务类型 (optional); func - 格子功能目前1常温2冷藏 (optional); kphone - 配送员手机号 (optional); orderid - 订单号 (optional); phone - 收货人手机号 (optional); size - 格子大小 (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

remotePutInBox

public RemotePutInResponse remotePutInBox(String apikey,
                                          String nonce,
                                          String sign,
                                          String boxno,
                                          String butype,
                                          String func,
                                          String kphone,
                                          String orderid,
                                          String phone,
                                          String size)
                                   throws ApiException

远程存

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); boxno - 柜子编号 (optional); butype - 业务类型 (optional); func - 格子功能目前1常温2冷藏 (optional); kphone - 配送员手机号 (optional); orderid - 订单号 (optional); phone - 收货人手机号 (optional); size - 格子大小 (optional)
Returns:: RemotePutInResponse
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

remotePutInBoxWithHttpInfo

public ApiResponse<RemotePutInResponse> remotePutInBoxWithHttpInfo(String apikey,
                                                                   String nonce,
                                                                   String sign,
                                                                   String boxno,
                                                                   String butype,
                                                                   String func,
                                                                   String kphone,
                                                                   String orderid,
                                                                   String phone,
                                                                   String size)
                                                            throws ApiException

远程存

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); boxno - 柜子编号 (optional); butype - 业务类型 (optional); func - 格子功能目前1常温2冷藏 (optional); kphone - 配送员手机号 (optional); orderid - 订单号 (optional); phone - 收货人手机号 (optional); size - 格子大小 (optional)
Returns:: ApiResponse<RemotePutInResponse>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

remotePutInBoxAsync

public com.squareup.okhttp.Call remotePutInBoxAsync(String apikey,
                                                    String nonce,
                                                    String sign,
                                                    String boxno,
                                                    String butype,
                                                    String func,
                                                    String kphone,
                                                    String orderid,
                                                    String phone,
                                                    String size,
                                                    ApiCallback<RemotePutInResponse> callback)
                                             throws ApiException

远程存 (asynchronously)

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); boxno - 柜子编号 (optional); butype - 业务类型 (optional); func - 格子功能目前1常温2冷藏 (optional); kphone - 配送员手机号 (optional); orderid - 订单号 (optional); phone - 收货人手机号 (optional); size - 格子大小 (optional); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

remotePutInBoxHistoryCall

public com.squareup.okhttp.Call remotePutInBoxHistoryCall(String apikey,
                                                          String nonce,
                                                          String sign,
                                                          String orderid,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for remotePutInBoxHistory

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); orderid - 订单号 (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

remotePutInBoxHistory

public RemotePutInHistoryResponse remotePutInBoxHistory(String apikey,
                                                        String nonce,
                                                        String sign,
                                                        String orderid)
                                                 throws ApiException

远程存

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); orderid - 订单号 (optional)
Returns:: RemotePutInHistoryResponse
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

remotePutInBoxHistoryWithHttpInfo

public ApiResponse<RemotePutInHistoryResponse> remotePutInBoxHistoryWithHttpInfo(String apikey,
                                                                                 String nonce,
                                                                                 String sign,
                                                                                 String orderid)
                                                                          throws ApiException

远程存

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); orderid - 订单号 (optional)
Returns:: ApiResponse<RemotePutInHistoryResponse>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

remotePutInBoxHistoryAsync

public com.squareup.okhttp.Call remotePutInBoxHistoryAsync(String apikey,
                                                           String nonce,
                                                           String sign,
                                                           String orderid,
                                                           ApiCallback<RemotePutInHistoryResponse> callback)
                                                    throws ApiException

远程存 (asynchronously)

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); orderid - 订单号 (optional); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

remoteTakeOutBoxCall

public com.squareup.okhttp.Call remoteTakeOutBoxCall(String apikey,
                                                     String nonce,
                                                     String sign,
                                                     String gridno,
                                                     String opencode,
                                                     String seqid,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for remoteTakeOutBox

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); gridno - 完整格号 (required); opencode - 取货密码 (required); seqid - 流水号 (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

remoteTakeOutBox

public RemoteTakeOutResponse remoteTakeOutBox(String apikey,
                                              String nonce,
                                              String sign,
                                              String gridno,
                                              String opencode,
                                              String seqid)
                                       throws ApiException

远程取

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); gridno - 完整格号 (required); opencode - 取货密码 (required); seqid - 流水号 (required)
Returns:: RemoteTakeOutResponse
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

remoteTakeOutBoxWithHttpInfo

public ApiResponse<RemoteTakeOutResponse> remoteTakeOutBoxWithHttpInfo(String apikey,
                                                                       String nonce,
                                                                       String sign,
                                                                       String gridno,
                                                                       String opencode,
                                                                       String seqid)
                                                                throws ApiException

远程取

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); gridno - 完整格号 (required); opencode - 取货密码 (required); seqid - 流水号 (required)
Returns:: ApiResponse<RemoteTakeOutResponse>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

remoteTakeOutBoxAsync

public com.squareup.okhttp.Call remoteTakeOutBoxAsync(String apikey,
                                                      String nonce,
                                                      String sign,
                                                      String gridno,
                                                      String opencode,
                                                      String seqid,
                                                      ApiCallback<RemoteTakeOutResponse> callback)
                                               throws ApiException

远程取 (asynchronously)

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); gridno - 完整格号 (required); opencode - 取货密码 (required); seqid - 流水号 (required); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

remoteTakeOutHistoryCall

public com.squareup.okhttp.Call remoteTakeOutHistoryCall(String apikey,
                                                         String nonce,
                                                         String sign,
                                                         String gridno,
                                                         String seqid,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for remoteTakeOutHistory

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); gridno - 完整格号 (required); seqid - 流水号 (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

remoteTakeOutHistory

public RemoteTakeOutResponse remoteTakeOutHistory(String apikey,
                                                  String nonce,
                                                  String sign,
                                                  String gridno,
                                                  String seqid)
                                           throws ApiException

查询取件状态

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); gridno - 完整格号 (required); seqid - 流水号 (required)
Returns:: RemoteTakeOutResponse
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

remoteTakeOutHistoryWithHttpInfo

public ApiResponse<RemoteTakeOutResponse> remoteTakeOutHistoryWithHttpInfo(String apikey,
                                                                           String nonce,
                                                                           String sign,
                                                                           String gridno,
                                                                           String seqid)
                                                                    throws ApiException

查询取件状态

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); gridno - 完整格号 (required); seqid - 流水号 (required)
Returns:: ApiResponse<RemoteTakeOutResponse>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

remoteTakeOutHistoryAsync

public com.squareup.okhttp.Call remoteTakeOutHistoryAsync(String apikey,
                                                          String nonce,
                                                          String sign,
                                                          String gridno,
                                                          String seqid,
                                                          ApiCallback<RemoteTakeOutResponse> callback)
                                                   throws ApiException

查询取件状态 (asynchronously)

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); gridno - 完整格号 (required); seqid - 流水号 (required); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

searchBoxCall

public com.squareup.okhttp.Call searchBoxCall(String apikey,
                                              String nonce,
                                              String sign,
                                              String city,
                                              String district,
                                              String branchno,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException

Build call for searchBox

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); city - 城市编号 (optional); district - 区号编号 (optional); branchno - 网点编号 (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

searchBox

public BoxSearchResponse searchBox(String apikey,
                                   String nonce,
                                   String sign,
                                   String city,
                                   String district,
                                   String branchno)
                            throws ApiException

根据城市及区号及网点编号查询下属柜子

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); city - 城市编号 (optional); district - 区号编号 (optional); branchno - 网点编号 (optional)
Returns:: BoxSearchResponse
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

searchBoxWithHttpInfo

public ApiResponse<BoxSearchResponse> searchBoxWithHttpInfo(String apikey,
                                                            String nonce,
                                                            String sign,
                                                            String city,
                                                            String district,
                                                            String branchno)
                                                     throws ApiException

根据城市及区号及网点编号查询下属柜子

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); city - 城市编号 (optional); district - 区号编号 (optional); branchno - 网点编号 (optional)
Returns:: ApiResponse<BoxSearchResponse>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

searchBoxAsync

public com.squareup.okhttp.Call searchBoxAsync(String apikey,
                                               String nonce,
                                               String sign,
                                               String city,
                                               String district,
                                               String branchno,
                                               ApiCallback<BoxSearchResponse> callback)
                                        throws ApiException

根据城市及区号及网点编号查询下属柜子 (asynchronously)

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); city - 城市编号 (optional); district - 区号编号 (optional); branchno - 网点编号 (optional); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

searchBranchBoxCall

public com.squareup.okhttp.Call searchBranchBoxCall(String apikey,
                                                    String nonce,
                                                    String sign,
                                                    String city,
                                                    String district,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for searchBranchBox

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); city - 城市编号 (optional); district - 区号编号 (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

searchBranchBox

public BranchBoxSearchResponse searchBranchBox(String apikey,
                                               String nonce,
                                               String sign,
                                               String city,
                                               String district)
                                        throws ApiException

根据城市及区号查询下属网点及柜子

Parameters:: apikey - key (required); nonce - 32位随机数 (required); sign - 用于校验 (required); city - 城市编号 (optional); district - 区号编号 (optional)
Returns:: BranchBoxSearchResponse
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

searchBranchBoxWithHttpInfo

public ApiResponse<BranchBoxSearchResponse> searchBranchBoxWithHttpInfo(String apikey,
                                                                        String nonce,
                                                                        String sign,
                                                                        String city,
                                                                        String district)
                                                                 throws ApiException