All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.alipay.v3.api.AlipayOpenSpOperationResultApi Maven / Gradle / Ivy

The newest version!
/*
 * 支付宝开放平台API
 * 支付宝开放平台v3协议文档
 *
 * The version of the OpenAPI document: 2024-08-30
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package com.alipay.v3.api;

import com.alipay.v3.ApiCallback;
import com.alipay.v3.ApiClient;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiResponse;
import com.alipay.v3.Configuration;
import com.alipay.v3.Pair;
import com.alipay.v3.ProgressRequestBody;
import com.alipay.v3.ProgressResponseBody;
import com.alipay.v3.util.AlipayLogger;
import com.alipay.v3.util.model.CustomizedParams;

import com.google.common.base.Strings;
import com.google.gson.reflect.TypeToken;

import java.io.IOException;


import com.alipay.v3.model.AlipayOpenSpOperationResultQueryDefaultResponse;
import com.alipay.v3.model.AlipayOpenSpOperationResultQueryResponseModel;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.ws.rs.core.GenericType;

public class AlipayOpenSpOperationResultApi {
    private ApiClient localVarApiClient;
    private int localHostIndex;
    private String localCustomBaseUrl;

    public AlipayOpenSpOperationResultApi() {
        this(Configuration.getDefaultApiClient());
    }

    public AlipayOpenSpOperationResultApi(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    public ApiClient getApiClient() {
        return localVarApiClient;
    }

    public void setApiClient(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    public int getHostIndex() {
        return localHostIndex;
    }

    public void setHostIndex(int hostIndex) {
        this.localHostIndex = hostIndex;
    }

    public String getCustomBaseUrl() {
        return localCustomBaseUrl;
    }

    public void setCustomBaseUrl(String customBaseUrl) {
        this.localCustomBaseUrl = customBaseUrl;
    }

    /**
     * Build call for query
     * @param operateType 代运营操作类型。取值如下 ACCOUNT_BIND:账号绑定; OPERATION_AUTH:代运营授权。 (optional)
     * @param batchNo 支付宝操作批次号。 batch_no提供基于操作批次的精确查询,只查询本操作批次的代运营操作结果,不反映最终代运营操作结果。 注意: 1.access_product_code、merchant_no、alipay_account三个参数组合与传入 batch_no 为两种查询方式,不可同时为空且以 batch_no 优先。 2.access_product_code、merchant_no、alipay_account三个参数组合可以查询最终代运营操作结果。 (optional)
     * @param accessProductCode 接入的产品编号。未传batch_no时必填,枚举如下: OPENAPI_BIND_DEFAULT:操作类型为账号绑定; OPENAPI_AUTH_DEFAULT:操作类型为代运营授权。 (optional)
     * @param merchantNo 支付宝商户号。支持间连、直连商户,值为2088开头。 未传batch_no时需注意: 若查询间连商户则 merchant_no 必填;  若查询直连商户,则merchant_no和alipay_account不能同时为空,都有值优先取merchant_no。 (optional)
     * @param alipayAccount 支付宝登录账号,通常为手机号或者邮箱。未传batch_no时需注意: 1.当查询merchant_no为间连商户时:   * 若 operate_type=ACCOUNT_BIND,则alipay_account必填。   * 若 operate_type=OPERATION_AUTH,则alipay_account无需传入。 2.当查询merchant_no为直连商户时:   * merchant_no和alipay_account不能同时为空,都有值优先取merchant_no。 (optional)
     * @param isvScenePermissions 场景授权列表结构结构:场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2; (optional)
     * @param _callback Callback for upload/download progress
     * @param customizedParams
     * @return Call to execute
     * @throws ApiException If fail to serialize the request body object
     * @http.response.details
     
Status Code Description Response Headers
200 common response -
0 请求失败 -
*/ public okhttp3.Call queryCall(String operateType, String batchNo, String accessProductCode, String merchantNo, String alipayAccount, String isvScenePermissions, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; // Determine Base Path to Use if (localCustomBaseUrl != null){ basePath = localCustomBaseUrl; } else if ( localBasePaths.length > 0 ) { basePath = localBasePaths[localHostIndex]; } else { basePath = null; } Object localVarPostBody = null; // create path and map variables String localVarPath = "/v3/alipay/open/sp/operation/result/query"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); if (operateType != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("operate_type", operateType)); } if (batchNo != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("batch_no", batchNo)); } if (accessProductCode != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("access_product_code", accessProductCode)); } if (merchantNo != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("merchant_no", merchantNo)); } if (alipayAccount != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("alipay_account", alipayAccount)); } if (isvScenePermissions != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("isv_scene_permissions", isvScenePermissions)); } final String[] localVarAccepts = { "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); if (localVarContentType != null) { localVarHeaderParams.put("Content-Type", localVarContentType); } if (customizedParams != null) { //额外query参数 if (customizedParams.getQueryParams() != null && customizedParams.getQueryParams().size() > 0) { for (Map.Entry entry : customizedParams.getQueryParams().entrySet()) { localVarQueryParams.addAll(localVarApiClient.parameterToPair(entry.getKey(), entry.getValue())); } } if (!Strings.isNullOrEmpty(customizedParams.getAppAuthToken())) { localVarHeaderParams.put("alipay-app-auth-token", customizedParams.getAppAuthToken()); } //额外非全局header参数 if (customizedParams.getHeaderParams() != null && customizedParams.getHeaderParams().size() > 0) { localVarHeaderParams.putAll(customizedParams.getHeaderParams()); } } String[] localVarAuthNames = new String[] { }; return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call queryValidateBeforeCall(String operateType, String batchNo, String accessProductCode, String merchantNo, String alipayAccount, String isvScenePermissions, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException { okhttp3.Call localVarCall = queryCall(operateType, batchNo, accessProductCode, merchantNo, alipayAccount, isvScenePermissions, _callback, customizedParams); return localVarCall; } /** * 查询服务商代运营操作结果 * 查询服务商代运营操作(代运营授权或者账号绑定)结果。提供两种查询方式: 方式一:operate_type + batch_no,提供基于操作批次的精确查询,只查询本操作批次的代运营操作结果,不反映最终代运营操作结果。 方式一查询方式优先级更高。 方式二:operate_type + access_product_code + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中。 方式三:operate_type + isv_scene_permissions + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中(仅支持查询授权结果)。 * @param operateType 代运营操作类型。取值如下 ACCOUNT_BIND:账号绑定; OPERATION_AUTH:代运营授权。 (optional) * @param batchNo 支付宝操作批次号。 batch_no提供基于操作批次的精确查询,只查询本操作批次的代运营操作结果,不反映最终代运营操作结果。 注意: 1.access_product_code、merchant_no、alipay_account三个参数组合与传入 batch_no 为两种查询方式,不可同时为空且以 batch_no 优先。 2.access_product_code、merchant_no、alipay_account三个参数组合可以查询最终代运营操作结果。 (optional) * @param accessProductCode 接入的产品编号。未传batch_no时必填,枚举如下: OPENAPI_BIND_DEFAULT:操作类型为账号绑定; OPENAPI_AUTH_DEFAULT:操作类型为代运营授权。 (optional) * @param merchantNo 支付宝商户号。支持间连、直连商户,值为2088开头。 未传batch_no时需注意: 若查询间连商户则 merchant_no 必填; 若查询直连商户,则merchant_no和alipay_account不能同时为空,都有值优先取merchant_no。 (optional) * @param alipayAccount 支付宝登录账号,通常为手机号或者邮箱。未传batch_no时需注意: 1.当查询merchant_no为间连商户时: * 若 operate_type=ACCOUNT_BIND,则alipay_account必填。 * 若 operate_type=OPERATION_AUTH,则alipay_account无需传入。 2.当查询merchant_no为直连商户时: * merchant_no和alipay_account不能同时为空,都有值优先取merchant_no。 (optional) * @param isvScenePermissions 场景授权列表结构结构:场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2; (optional) * @return AlipayOpenSpOperationResultQueryResponseModel * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 common response -
0 请求失败 -
*/ public AlipayOpenSpOperationResultQueryResponseModel query(String operateType, String batchNo, String accessProductCode, String merchantNo, String alipayAccount, String isvScenePermissions) throws ApiException { ApiResponse localVarResp = queryWithHttpInfo(operateType, batchNo, accessProductCode, merchantNo, alipayAccount, isvScenePermissions, null); return localVarResp.getData(); } public AlipayOpenSpOperationResultQueryResponseModel query(String operateType, String batchNo, String accessProductCode, String merchantNo, String alipayAccount, String isvScenePermissions, CustomizedParams customizedParams) throws ApiException { ApiResponse localVarResp = queryWithHttpInfo(operateType, batchNo, accessProductCode, merchantNo, alipayAccount, isvScenePermissions, customizedParams); return localVarResp.getData(); } /** * 查询服务商代运营操作结果 * 查询服务商代运营操作(代运营授权或者账号绑定)结果。提供两种查询方式: 方式一:operate_type + batch_no,提供基于操作批次的精确查询,只查询本操作批次的代运营操作结果,不反映最终代运营操作结果。 方式一查询方式优先级更高。 方式二:operate_type + access_product_code + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中。 方式三:operate_type + isv_scene_permissions + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中(仅支持查询授权结果)。 * @param operateType 代运营操作类型。取值如下 ACCOUNT_BIND:账号绑定; OPERATION_AUTH:代运营授权。 (optional) * @param batchNo 支付宝操作批次号。 batch_no提供基于操作批次的精确查询,只查询本操作批次的代运营操作结果,不反映最终代运营操作结果。 注意: 1.access_product_code、merchant_no、alipay_account三个参数组合与传入 batch_no 为两种查询方式,不可同时为空且以 batch_no 优先。 2.access_product_code、merchant_no、alipay_account三个参数组合可以查询最终代运营操作结果。 (optional) * @param accessProductCode 接入的产品编号。未传batch_no时必填,枚举如下: OPENAPI_BIND_DEFAULT:操作类型为账号绑定; OPENAPI_AUTH_DEFAULT:操作类型为代运营授权。 (optional) * @param merchantNo 支付宝商户号。支持间连、直连商户,值为2088开头。 未传batch_no时需注意: 若查询间连商户则 merchant_no 必填; 若查询直连商户,则merchant_no和alipay_account不能同时为空,都有值优先取merchant_no。 (optional) * @param alipayAccount 支付宝登录账号,通常为手机号或者邮箱。未传batch_no时需注意: 1.当查询merchant_no为间连商户时: * 若 operate_type=ACCOUNT_BIND,则alipay_account必填。 * 若 operate_type=OPERATION_AUTH,则alipay_account无需传入。 2.当查询merchant_no为直连商户时: * merchant_no和alipay_account不能同时为空,都有值优先取merchant_no。 (optional) * @param isvScenePermissions 场景授权列表结构结构:场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2; (optional) * @return ApiResponse<AlipayOpenSpOperationResultQueryResponseModel> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 common response -
0 请求失败 -
*/ public ApiResponse queryWithHttpInfo(String operateType, String batchNo, String accessProductCode, String merchantNo, String alipayAccount, String isvScenePermissions, CustomizedParams customizedParams) throws ApiException { okhttp3.Call localVarCall = queryValidateBeforeCall(operateType, batchNo, accessProductCode, merchantNo, alipayAccount, isvScenePermissions, null, customizedParams); try { Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } catch (ApiException e) { try { e.setErrorObject(localVarApiClient.getJSON().getGson().fromJson(e.getResponseBody(), new TypeToken(){}.getType())); } catch (Exception ex) { AlipayLogger.logBizWarn(ex); } throw e; } } /** * 查询服务商代运营操作结果 (asynchronously) * 查询服务商代运营操作(代运营授权或者账号绑定)结果。提供两种查询方式: 方式一:operate_type + batch_no,提供基于操作批次的精确查询,只查询本操作批次的代运营操作结果,不反映最终代运营操作结果。 方式一查询方式优先级更高。 方式二:operate_type + access_product_code + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中。 方式三:operate_type + isv_scene_permissions + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中(仅支持查询授权结果)。 * @param operateType 代运营操作类型。取值如下 ACCOUNT_BIND:账号绑定; OPERATION_AUTH:代运营授权。 (optional) * @param batchNo 支付宝操作批次号。 batch_no提供基于操作批次的精确查询,只查询本操作批次的代运营操作结果,不反映最终代运营操作结果。 注意: 1.access_product_code、merchant_no、alipay_account三个参数组合与传入 batch_no 为两种查询方式,不可同时为空且以 batch_no 优先。 2.access_product_code、merchant_no、alipay_account三个参数组合可以查询最终代运营操作结果。 (optional) * @param accessProductCode 接入的产品编号。未传batch_no时必填,枚举如下: OPENAPI_BIND_DEFAULT:操作类型为账号绑定; OPENAPI_AUTH_DEFAULT:操作类型为代运营授权。 (optional) * @param merchantNo 支付宝商户号。支持间连、直连商户,值为2088开头。 未传batch_no时需注意: 若查询间连商户则 merchant_no 必填; 若查询直连商户,则merchant_no和alipay_account不能同时为空,都有值优先取merchant_no。 (optional) * @param alipayAccount 支付宝登录账号,通常为手机号或者邮箱。未传batch_no时需注意: 1.当查询merchant_no为间连商户时: * 若 operate_type=ACCOUNT_BIND,则alipay_account必填。 * 若 operate_type=OPERATION_AUTH,则alipay_account无需传入。 2.当查询merchant_no为直连商户时: * merchant_no和alipay_account不能同时为空,都有值优先取merchant_no。 (optional) * @param isvScenePermissions 场景授权列表结构结构:场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2; (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 common response -
0 请求失败 -
* @deprecated */ @Deprecated public okhttp3.Call queryAsync(String operateType, String batchNo, String accessProductCode, String merchantNo, String alipayAccount, String isvScenePermissions, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = queryValidateBeforeCall(operateType, batchNo, accessProductCode, merchantNo, alipayAccount, isvScenePermissions, _callback, null); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @Deprecated public okhttp3.Call queryAsync(String operateType, String batchNo, String accessProductCode, String merchantNo, String alipayAccount, String isvScenePermissions, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException { okhttp3.Call localVarCall = queryValidateBeforeCall(operateType, batchNo, accessProductCode, merchantNo, alipayAccount, isvScenePermissions, _callback, customizedParams); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy