Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.alipay.v3.api.AlipayMarketingActivityUserApi Maven / Gradle / Ivy
/*
* 支付宝开放平台API
* 支付宝开放平台v3协议文档
*
* The version of the OpenAPI document: 2024-01-12
*
*
* 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.AlipayMarketingActivityUserBatchqueryvoucherDefaultResponse;
import com.alipay.v3.model.AlipayMarketingActivityUserBatchqueryvoucherResponseModel;
import com.alipay.v3.model.AlipayMarketingActivityUserQueryvoucherDefaultResponse;
import com.alipay.v3.model.AlipayMarketingActivityUserQueryvoucherResponseModel;
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 AlipayMarketingActivityUserApi {
private ApiClient localVarApiClient;
private int localHostIndex;
private String localCustomBaseUrl;
public AlipayMarketingActivityUserApi() {
this(Configuration.getDefaultApiClient());
}
public AlipayMarketingActivityUserApi(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 batchqueryvoucher
* @param authToken 用户授权令牌 (optional)
* @param userId 支付宝用户 id (optional)
* @param openId 支付宝用户openId (optional)
* @param activityId 活动 id (optional)
* @param belongMerchantId 券归属商户 (optional)
* @param senderMerchantId 券发放商户 (optional)
* @param voucherStatus 券状态，其中已过期状态可查询6个月内的数据 (optional)
* @param pageNum 分页查询页码 (optional)
* @param merchantAccessMode 商户接入模式 (optional)
* @param pageSize 分页查询单页数据条数 (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 batchqueryvoucherCall(String authToken, String userId, String openId, String activityId, String belongMerchantId, String senderMerchantId, String voucherStatus, Integer pageNum, String merchantAccessMode, Integer pageSize, 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/marketing/activity/ordervoucher/user/batchqueryvoucher";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (authToken != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("auth_token", authToken));
}
if (userId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("user_id", userId));
}
if (openId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("open_id", openId));
}
if (activityId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("activity_id", activityId));
}
if (belongMerchantId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("belong_merchant_id", belongMerchantId));
}
if (senderMerchantId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sender_merchant_id", senderMerchantId));
}
if (voucherStatus != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("voucher_status", voucherStatus));
}
if (pageNum != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page_num", pageNum));
}
if (merchantAccessMode != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("merchant_access_mode", merchantAccessMode));
}
if (pageSize != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page_size", pageSize));
}
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 batchqueryvoucherValidateBeforeCall(String authToken, String userId, String openId, String activityId, String belongMerchantId, String senderMerchantId, String voucherStatus, Integer pageNum, String merchantAccessMode, Integer pageSize, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
okhttp3.Call localVarCall = batchqueryvoucherCall(authToken, userId, openId, activityId, belongMerchantId, senderMerchantId, voucherStatus, pageNum, merchantAccessMode, pageSize, _callback, customizedParams);
return localVarCall;
}
/**
* 条件查询用户券
* 可通过该接口查询用户在某商户可用的全部券，可用于商户的小程序/H5中，用户\"我的优惠券\"或\"提交订单页\"展示优惠信息。只能查询商户配的券，无法查询平台优惠券。
* @param authToken 用户授权令牌 (optional)
* @param userId 支付宝用户 id (optional)
* @param openId 支付宝用户openId (optional)
* @param activityId 活动 id (optional)
* @param belongMerchantId 券归属商户 (optional)
* @param senderMerchantId 券发放商户 (optional)
* @param voucherStatus 券状态，其中已过期状态可查询6个月内的数据 (optional)
* @param pageNum 分页查询页码 (optional)
* @param merchantAccessMode 商户接入模式 (optional)
* @param pageSize 分页查询单页数据条数 (optional)
* @return AlipayMarketingActivityUserBatchqueryvoucherResponseModel
* @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 AlipayMarketingActivityUserBatchqueryvoucherResponseModel batchqueryvoucher(String authToken, String userId, String openId, String activityId, String belongMerchantId, String senderMerchantId, String voucherStatus, Integer pageNum, String merchantAccessMode, Integer pageSize) throws ApiException {
ApiResponse localVarResp = batchqueryvoucherWithHttpInfo(authToken, userId, openId, activityId, belongMerchantId, senderMerchantId, voucherStatus, pageNum, merchantAccessMode, pageSize, null);
return localVarResp.getData();
}
public AlipayMarketingActivityUserBatchqueryvoucherResponseModel batchqueryvoucher(String authToken, String userId, String openId, String activityId, String belongMerchantId, String senderMerchantId, String voucherStatus, Integer pageNum, String merchantAccessMode, Integer pageSize, CustomizedParams customizedParams) throws ApiException {
ApiResponse localVarResp = batchqueryvoucherWithHttpInfo(authToken, userId, openId, activityId, belongMerchantId, senderMerchantId, voucherStatus, pageNum, merchantAccessMode, pageSize, customizedParams);
return localVarResp.getData();
}
/**
* 条件查询用户券
* 可通过该接口查询用户在某商户可用的全部券，可用于商户的小程序/H5中，用户\"我的优惠券\"或\"提交订单页\"展示优惠信息。只能查询商户配的券，无法查询平台优惠券。
* @param authToken 用户授权令牌 (optional)
* @param userId 支付宝用户 id (optional)
* @param openId 支付宝用户openId (optional)
* @param activityId 活动 id (optional)
* @param belongMerchantId 券归属商户 (optional)
* @param senderMerchantId 券发放商户 (optional)
* @param voucherStatus 券状态，其中已过期状态可查询6个月内的数据 (optional)
* @param pageNum 分页查询页码 (optional)
* @param merchantAccessMode 商户接入模式 (optional)
* @param pageSize 分页查询单页数据条数 (optional)
* @return ApiResponse<AlipayMarketingActivityUserBatchqueryvoucherResponseModel>
* @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 batchqueryvoucherWithHttpInfo(String authToken, String userId, String openId, String activityId, String belongMerchantId, String senderMerchantId, String voucherStatus, Integer pageNum, String merchantAccessMode, Integer pageSize, CustomizedParams customizedParams) throws ApiException {
okhttp3.Call localVarCall = batchqueryvoucherValidateBeforeCall(authToken, userId, openId, activityId, belongMerchantId, senderMerchantId, voucherStatus, pageNum, merchantAccessMode, pageSize, 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)
* 可通过该接口查询用户在某商户可用的全部券，可用于商户的小程序/H5中，用户\"我的优惠券\"或\"提交订单页\"展示优惠信息。只能查询商户配的券，无法查询平台优惠券。
* @param authToken 用户授权令牌 (optional)
* @param userId 支付宝用户 id (optional)
* @param openId 支付宝用户openId (optional)
* @param activityId 活动 id (optional)
* @param belongMerchantId 券归属商户 (optional)
* @param senderMerchantId 券发放商户 (optional)
* @param voucherStatus 券状态，其中已过期状态可查询6个月内的数据 (optional)
* @param pageNum 分页查询页码 (optional)
* @param merchantAccessMode 商户接入模式 (optional)
* @param pageSize 分页查询单页数据条数 (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 请求失败 -
*/
public okhttp3.Call batchqueryvoucherAsync(String authToken, String userId, String openId, String activityId, String belongMerchantId, String senderMerchantId, String voucherStatus, Integer pageNum, String merchantAccessMode, Integer pageSize, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = batchqueryvoucherValidateBeforeCall(authToken, userId, openId, activityId, belongMerchantId, senderMerchantId, voucherStatus, pageNum, merchantAccessMode, pageSize, _callback, null);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public okhttp3.Call batchqueryvoucherAsync(String authToken, String userId, String openId, String activityId, String belongMerchantId, String senderMerchantId, String voucherStatus, Integer pageNum, String merchantAccessMode, Integer pageSize, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
okhttp3.Call localVarCall = batchqueryvoucherValidateBeforeCall(authToken, userId, openId, activityId, belongMerchantId, senderMerchantId, voucherStatus, pageNum, merchantAccessMode, pageSize, _callback, customizedParams);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for queryvoucher
* @param merchantId 商户 PID，默认为当前接口调用商户。 (optional)
* @param userId 支付宝user_id账号 (optional)
* @param openId 领券的支付宝用户openId (optional)
* @param activityId 活动id (optional)
* @param voucherId 用户券 id。支付宝为用户优惠券唯一分配的 id。 (optional)
* @param voucherCode 用户领取的商家券券码。 (optional)
* @param merchantAccessMode 商户接入模式。 (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 queryvoucherCall(String merchantId, String userId, String openId, String activityId, String voucherId, String voucherCode, String merchantAccessMode, 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/marketing/activity/ordervoucher/user/voucher";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (merchantId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("merchant_id", merchantId));
}
if (userId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("user_id", userId));
}
if (openId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("open_id", openId));
}
if (activityId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("activity_id", activityId));
}
if (voucherId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("voucher_id", voucherId));
}
if (voucherCode != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("voucher_code", voucherCode));
}
if (merchantAccessMode != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("merchant_access_mode", merchantAccessMode));
}
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 queryvoucherValidateBeforeCall(String merchantId, String userId, String openId, String activityId, String voucherId, String voucherCode, String merchantAccessMode, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
okhttp3.Call localVarCall = queryvoucherCall(merchantId, userId, openId, activityId, voucherId, voucherCode, merchantAccessMode, _callback, customizedParams);
return localVarCall;
}
/**
* 查询用户券详情
* 通过此接口可以查询用户券信息，包括用户券的基础信息、状态。
* @param merchantId 商户 PID，默认为当前接口调用商户。 (optional)
* @param userId 支付宝user_id账号 (optional)
* @param openId 领券的支付宝用户openId (optional)
* @param activityId 活动id (optional)
* @param voucherId 用户券 id。支付宝为用户优惠券唯一分配的 id。 (optional)
* @param voucherCode 用户领取的商家券券码。 (optional)
* @param merchantAccessMode 商户接入模式。 (optional)
* @return AlipayMarketingActivityUserQueryvoucherResponseModel
* @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 AlipayMarketingActivityUserQueryvoucherResponseModel queryvoucher(String merchantId, String userId, String openId, String activityId, String voucherId, String voucherCode, String merchantAccessMode) throws ApiException {
ApiResponse localVarResp = queryvoucherWithHttpInfo(merchantId, userId, openId, activityId, voucherId, voucherCode, merchantAccessMode, null);
return localVarResp.getData();
}
public AlipayMarketingActivityUserQueryvoucherResponseModel queryvoucher(String merchantId, String userId, String openId, String activityId, String voucherId, String voucherCode, String merchantAccessMode, CustomizedParams customizedParams) throws ApiException {
ApiResponse localVarResp = queryvoucherWithHttpInfo(merchantId, userId, openId, activityId, voucherId, voucherCode, merchantAccessMode, customizedParams);
return localVarResp.getData();
}
/**
* 查询用户券详情
* 通过此接口可以查询用户券信息，包括用户券的基础信息、状态。
* @param merchantId 商户 PID，默认为当前接口调用商户。 (optional)
* @param userId 支付宝user_id账号 (optional)
* @param openId 领券的支付宝用户openId (optional)
* @param activityId 活动id (optional)
* @param voucherId 用户券 id。支付宝为用户优惠券唯一分配的 id。 (optional)
* @param voucherCode 用户领取的商家券券码。 (optional)
* @param merchantAccessMode 商户接入模式。 (optional)
* @return ApiResponse<AlipayMarketingActivityUserQueryvoucherResponseModel>
* @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 queryvoucherWithHttpInfo(String merchantId, String userId, String openId, String activityId, String voucherId, String voucherCode, String merchantAccessMode, CustomizedParams customizedParams) throws ApiException {
okhttp3.Call localVarCall = queryvoucherValidateBeforeCall(merchantId, userId, openId, activityId, voucherId, voucherCode, merchantAccessMode, 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)
* 通过此接口可以查询用户券信息，包括用户券的基础信息、状态。
* @param merchantId 商户 PID，默认为当前接口调用商户。 (optional)
* @param userId 支付宝user_id账号 (optional)
* @param openId 领券的支付宝用户openId (optional)
* @param activityId 活动id (optional)
* @param voucherId 用户券 id。支付宝为用户优惠券唯一分配的 id。 (optional)
* @param voucherCode 用户领取的商家券券码。 (optional)
* @param merchantAccessMode 商户接入模式。 (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 请求失败 -
*/
public okhttp3.Call queryvoucherAsync(String merchantId, String userId, String openId, String activityId, String voucherId, String voucherCode, String merchantAccessMode, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = queryvoucherValidateBeforeCall(merchantId, userId, openId, activityId, voucherId, voucherCode, merchantAccessMode, _callback, null);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public okhttp3.Call queryvoucherAsync(String merchantId, String userId, String openId, String activityId, String voucherId, String voucherCode, String merchantAccessMode, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
okhttp3.Call localVarCall = queryvoucherValidateBeforeCall(merchantId, userId, openId, activityId, voucherId, voucherCode, merchantAccessMode, _callback, customizedParams);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
}
