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.
/*
* Zuora API Reference
* REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).
*
* The version of the OpenAPI document: 2024-05-20
* Contact: [email protected]
*
* 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.zuora.api;
import com.zuora.ApiCallback;
import com.zuora.ApiClient;
import com.zuora.ApiException;
import com.zuora.ApiResponse;
import com.zuora.Configuration;
import com.zuora.Pair;
import com.zuora.ProgressRequestBody;
import com.zuora.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import java.math.BigDecimal;
import com.zuora.model.DailyConsumptionRevRecRequest;
import com.zuora.model.ProxyUnauthorizedResponse;
import com.zuora.model.RegenerateBillingRequest;
import com.zuora.model.RegenerateBookingRequest;
import com.zuora.model.RegenerateRevRecEventsResponse;
import com.zuora.model.RegenerateTransactionObjectResponse;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class RegenerateApi {
private ApiClient localVarApiClient;
private int localHostIndex;
private String localCustomBaseUrl;
public RegenerateApi() {
this(Configuration.getDefaultApiClient());
}
public RegenerateApi(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;
}
private okhttp3.Call pOSTCreateRevRecEventsCall(String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, String subscriptionNumber, String mode, Boolean forRevenueRecollect, String zuoraOrgIds, final ApiCallback _callback) 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 = "/v1/uno-regenerate/rev-rec-events";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (pageSize != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("pageSize", pageSize));
}
if (subscriptionNumber != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("subscriptionNumber", subscriptionNumber));
}
if (mode != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("mode", mode));
}
if (forRevenueRecollect != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("forRevenueRecollect", forRevenueRecollect));
}
if (acceptEncoding != null) {
localVarHeaderParams.put("Accept-Encoding", localVarApiClient.parameterToString(acceptEncoding));
}
if (contentEncoding != null) {
localVarHeaderParams.put("Content-Encoding", localVarApiClient.parameterToString(contentEncoding));
}
if (authorization != null) {
localVarHeaderParams.put("Authorization", localVarApiClient.parameterToString(authorization));
}
if (zuoraTrackId != null) {
localVarHeaderParams.put("Zuora-Track-Id", localVarApiClient.parameterToString(zuoraTrackId));
}
if (zuoraEntityIds != null) {
localVarHeaderParams.put("Zuora-Entity-Ids", localVarApiClient.parameterToString(zuoraEntityIds));
}
if (zuoraOrgIds != null) {
localVarHeaderParams.put("Zuora-Org-Ids", localVarApiClient.parameterToString(zuoraOrgIds));
}
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);
}
String[] localVarAuthNames = new String[] { "bearerAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call pOSTCreateRevRecEventsValidateBeforeCall(String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, String subscriptionNumber, String mode, Boolean forRevenueRecollect, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {
return pOSTCreateRevRecEventsCall(acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, subscriptionNumber, mode, forRevenueRecollect, zuoraOrgIds, _callback);
}
/**
* Regenerate Rev Rec Event
* This call is used to generate DeliverySchedule based RevRecEvents.
* @param acceptEncoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. (optional)
* @param contentEncoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. (optional)
* @param authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). (optional)
* @param zuoraTrackId A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
* @param zuoraEntityIds An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
* @param page The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. (optional, default to 1)
* @param pageSize The number of records returned per page in the response. (optional, default to 20)
* @param subscriptionNumber subscription number (optional)
* @param mode generation mode (optional)
* @param forRevenueRecollect flag to indicate if data regenerated is for Revenue to recollect (optional)
* @param zuoraOrgIds Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. (optional)
* @return RegenerateRevRecEventsResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
protected RegenerateRevRecEventsResponse pOSTCreateRevRecEvents(String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, String subscriptionNumber, String mode, Boolean forRevenueRecollect, String zuoraOrgIds) throws ApiException {
ApiResponse localVarResp = pOSTCreateRevRecEventsWithHttpInfo(acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, subscriptionNumber, mode, forRevenueRecollect, zuoraOrgIds);
return localVarResp.getData();
}
private ApiResponse pOSTCreateRevRecEventsWithHttpInfo(String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, String subscriptionNumber, String mode, Boolean forRevenueRecollect, String zuoraOrgIds) throws ApiException {
okhttp3.Call localVarCall = pOSTCreateRevRecEventsValidateBeforeCall(acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, subscriptionNumber, mode, forRevenueRecollect, zuoraOrgIds, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private okhttp3.Call pOSTCreateRevRecEventsAsync(String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, String subscriptionNumber, String mode, Boolean forRevenueRecollect, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = pOSTCreateRevRecEventsValidateBeforeCall(acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, subscriptionNumber, mode, forRevenueRecollect, zuoraOrgIds, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public class POSTCreateRevRecEventsApi {
private String acceptEncoding;
private String contentEncoding;
private String authorization;
private String zuoraTrackId;
private String zuoraEntityIds;
private Integer page;
private Integer pageSize;
private String subscriptionNumber;
private String mode;
private Boolean forRevenueRecollect;
private String zuoraOrgIds;
private POSTCreateRevRecEventsApi() {
}
/**
* Set acceptEncoding
* @param acceptEncoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. (optional)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi acceptEncoding(String acceptEncoding) {
this.acceptEncoding = acceptEncoding;
return this;
}
/**
* Set contentEncoding
* @param contentEncoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. (optional)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi contentEncoding(String contentEncoding) {
this.contentEncoding = contentEncoding;
return this;
}
/**
* Set authorization
* @param authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). (optional)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi authorization(String authorization) {
this.authorization = authorization;
return this;
}
/**
* Set zuoraTrackId
* @param zuoraTrackId A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi zuoraTrackId(String zuoraTrackId) {
this.zuoraTrackId = zuoraTrackId;
return this;
}
/**
* Set zuoraEntityIds
* @param zuoraEntityIds An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi zuoraEntityIds(String zuoraEntityIds) {
this.zuoraEntityIds = zuoraEntityIds;
return this;
}
/**
* Set page
* @param page The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. (optional, default to 1)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi page(Integer page) {
this.page = page;
return this;
}
/**
* Set pageSize
* @param pageSize The number of records returned per page in the response. (optional, default to 20)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi pageSize(Integer pageSize) {
this.pageSize = pageSize;
return this;
}
/**
* Set subscriptionNumber
* @param subscriptionNumber subscription number (optional)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi subscriptionNumber(String subscriptionNumber) {
this.subscriptionNumber = subscriptionNumber;
return this;
}
/**
* Set mode
* @param mode generation mode (optional)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi mode(String mode) {
this.mode = mode;
return this;
}
/**
* Set forRevenueRecollect
* @param forRevenueRecollect flag to indicate if data regenerated is for Revenue to recollect (optional)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi forRevenueRecollect(Boolean forRevenueRecollect) {
this.forRevenueRecollect = forRevenueRecollect;
return this;
}
/**
* Set zuoraOrgIds
* @param zuoraOrgIds Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. (optional)
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi zuoraOrgIds(String zuoraOrgIds) {
this.zuoraOrgIds = zuoraOrgIds;
return this;
}
/**
* Build call for pOSTCreateRevRecEvents
* @param _callback ApiCallback API callback
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
public RegenerateRevRecEventsResponse execute() throws ApiException {
ApiResponse localVarResp = pOSTCreateRevRecEventsWithHttpInfo(acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, subscriptionNumber, mode, forRevenueRecollect, zuoraOrgIds);
return localVarResp.getData();
}
/**
* Execute pOSTCreateRevRecEvents request with HTTP info returned
* @return ApiResponse<RegenerateRevRecEventsResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
private ApiResponse executeWithHttpInfo() throws ApiException {
return pOSTCreateRevRecEventsWithHttpInfo(acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, subscriptionNumber, mode, forRevenueRecollect, zuoraOrgIds);
}
/**
* Execute pOSTCreateRevRecEvents request (asynchronously)
* @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
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
return pOSTCreateRevRecEventsAsync(acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, subscriptionNumber, mode, forRevenueRecollect, zuoraOrgIds, _callback);
}
}
/**
* Regenerate Rev Rec Event
* This call is used to generate DeliverySchedule based RevRecEvents.
* @return POSTCreateRevRecEventsApi
*/
public POSTCreateRevRecEventsApi pOSTCreateRevRecEventsApi() {
return new POSTCreateRevRecEventsApi();
}
private okhttp3.Call pOSTGenerateRevRecEventsForDailyConsumptionCall(DailyConsumptionRevRecRequest dailyConsumptionRevRecRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean forRevenueRecollect, String zuoraOrgIds, final ApiCallback _callback) 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 = dailyConsumptionRevRecRequest;
// create path and map variables
String localVarPath = "/v1/uno-regenerate/rev-rec-events/daily-consumption";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (pageSize != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("pageSize", pageSize));
}
if (forRevenueRecollect != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("forRevenueRecollect", forRevenueRecollect));
}
if (acceptEncoding != null) {
localVarHeaderParams.put("Accept-Encoding", localVarApiClient.parameterToString(acceptEncoding));
}
if (contentEncoding != null) {
localVarHeaderParams.put("Content-Encoding", localVarApiClient.parameterToString(contentEncoding));
}
if (authorization != null) {
localVarHeaderParams.put("Authorization", localVarApiClient.parameterToString(authorization));
}
if (zuoraTrackId != null) {
localVarHeaderParams.put("Zuora-Track-Id", localVarApiClient.parameterToString(zuoraTrackId));
}
if (zuoraEntityIds != null) {
localVarHeaderParams.put("Zuora-Entity-Ids", localVarApiClient.parameterToString(zuoraEntityIds));
}
if (zuoraOrgIds != null) {
localVarHeaderParams.put("Zuora-Org-Ids", localVarApiClient.parameterToString(zuoraOrgIds));
}
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "bearerAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call pOSTGenerateRevRecEventsForDailyConsumptionValidateBeforeCall(DailyConsumptionRevRecRequest dailyConsumptionRevRecRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean forRevenueRecollect, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'dailyConsumptionRevRecRequest' is set
if (dailyConsumptionRevRecRequest == null) {
throw new ApiException("Missing the required parameter 'dailyConsumptionRevRecRequest' when calling pOSTGenerateRevRecEventsForDailyConsumption(Async)");
}
return pOSTGenerateRevRecEventsForDailyConsumptionCall(dailyConsumptionRevRecRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, forRevenueRecollect, zuoraOrgIds, _callback);
}
/**
* Regenerate Rev Rec Event
* This call is used to generate PPDD DailyConsumption based RevRecEvents.
* @param dailyConsumptionRevRecRequest The request body to regenerate PPDD Daily Consumption based Rev Rec Event (required)
* @param acceptEncoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. (optional)
* @param contentEncoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. (optional)
* @param authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). (optional)
* @param zuoraTrackId A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
* @param zuoraEntityIds An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
* @param page The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. (optional, default to 1)
* @param pageSize The number of records returned per page in the response. (optional, default to 20)
* @param forRevenueRecollect flag to indicate if data regenerated is for Revenue to recollect (optional)
* @param zuoraOrgIds Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. (optional)
* @return RegenerateRevRecEventsResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
protected RegenerateRevRecEventsResponse pOSTGenerateRevRecEventsForDailyConsumption(DailyConsumptionRevRecRequest dailyConsumptionRevRecRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean forRevenueRecollect, String zuoraOrgIds) throws ApiException {
ApiResponse localVarResp = pOSTGenerateRevRecEventsForDailyConsumptionWithHttpInfo(dailyConsumptionRevRecRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, forRevenueRecollect, zuoraOrgIds);
return localVarResp.getData();
}
private ApiResponse pOSTGenerateRevRecEventsForDailyConsumptionWithHttpInfo(DailyConsumptionRevRecRequest dailyConsumptionRevRecRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean forRevenueRecollect, String zuoraOrgIds) throws ApiException {
okhttp3.Call localVarCall = pOSTGenerateRevRecEventsForDailyConsumptionValidateBeforeCall(dailyConsumptionRevRecRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, forRevenueRecollect, zuoraOrgIds, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private okhttp3.Call pOSTGenerateRevRecEventsForDailyConsumptionAsync(DailyConsumptionRevRecRequest dailyConsumptionRevRecRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean forRevenueRecollect, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = pOSTGenerateRevRecEventsForDailyConsumptionValidateBeforeCall(dailyConsumptionRevRecRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, forRevenueRecollect, zuoraOrgIds, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public class POSTGenerateRevRecEventsForDailyConsumptionApi {
private final DailyConsumptionRevRecRequest dailyConsumptionRevRecRequest;
private String acceptEncoding;
private String contentEncoding;
private String authorization;
private String zuoraTrackId;
private String zuoraEntityIds;
private Integer page;
private Integer pageSize;
private Boolean forRevenueRecollect;
private String zuoraOrgIds;
private POSTGenerateRevRecEventsForDailyConsumptionApi(DailyConsumptionRevRecRequest dailyConsumptionRevRecRequest) {
this.dailyConsumptionRevRecRequest = dailyConsumptionRevRecRequest;
}
/**
* Set acceptEncoding
* @param acceptEncoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. (optional)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi acceptEncoding(String acceptEncoding) {
this.acceptEncoding = acceptEncoding;
return this;
}
/**
* Set contentEncoding
* @param contentEncoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. (optional)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi contentEncoding(String contentEncoding) {
this.contentEncoding = contentEncoding;
return this;
}
/**
* Set authorization
* @param authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). (optional)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi authorization(String authorization) {
this.authorization = authorization;
return this;
}
/**
* Set zuoraTrackId
* @param zuoraTrackId A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi zuoraTrackId(String zuoraTrackId) {
this.zuoraTrackId = zuoraTrackId;
return this;
}
/**
* Set zuoraEntityIds
* @param zuoraEntityIds An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi zuoraEntityIds(String zuoraEntityIds) {
this.zuoraEntityIds = zuoraEntityIds;
return this;
}
/**
* Set page
* @param page The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. (optional, default to 1)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi page(Integer page) {
this.page = page;
return this;
}
/**
* Set pageSize
* @param pageSize The number of records returned per page in the response. (optional, default to 20)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi pageSize(Integer pageSize) {
this.pageSize = pageSize;
return this;
}
/**
* Set forRevenueRecollect
* @param forRevenueRecollect flag to indicate if data regenerated is for Revenue to recollect (optional)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi forRevenueRecollect(Boolean forRevenueRecollect) {
this.forRevenueRecollect = forRevenueRecollect;
return this;
}
/**
* Set zuoraOrgIds
* @param zuoraOrgIds Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. (optional)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi zuoraOrgIds(String zuoraOrgIds) {
this.zuoraOrgIds = zuoraOrgIds;
return this;
}
/**
* Build call for pOSTGenerateRevRecEventsForDailyConsumption
* @param _callback ApiCallback API callback
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
public RegenerateRevRecEventsResponse execute() throws ApiException {
ApiResponse localVarResp = pOSTGenerateRevRecEventsForDailyConsumptionWithHttpInfo(dailyConsumptionRevRecRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, forRevenueRecollect, zuoraOrgIds);
return localVarResp.getData();
}
/**
* Execute pOSTGenerateRevRecEventsForDailyConsumption request with HTTP info returned
* @return ApiResponse<RegenerateRevRecEventsResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
private ApiResponse executeWithHttpInfo() throws ApiException {
return pOSTGenerateRevRecEventsForDailyConsumptionWithHttpInfo(dailyConsumptionRevRecRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, forRevenueRecollect, zuoraOrgIds);
}
/**
* Execute pOSTGenerateRevRecEventsForDailyConsumption request (asynchronously)
* @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
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
return pOSTGenerateRevRecEventsForDailyConsumptionAsync(dailyConsumptionRevRecRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, forRevenueRecollect, zuoraOrgIds, _callback);
}
}
/**
* Regenerate Rev Rec Event
* This call is used to generate PPDD DailyConsumption based RevRecEvents.
* @param dailyConsumptionRevRecRequest The request body to regenerate PPDD Daily Consumption based Rev Rec Event (required)
* @return POSTGenerateRevRecEventsForDailyConsumptionApi
*/
public POSTGenerateRevRecEventsForDailyConsumptionApi pOSTGenerateRevRecEventsForDailyConsumptionApi(DailyConsumptionRevRecRequest dailyConsumptionRevRecRequest) {
return new POSTGenerateRevRecEventsForDailyConsumptionApi(dailyConsumptionRevRecRequest);
}
private okhttp3.Call pOSTRegenerateBillingTransactionCall(RegenerateBillingRequest regenerateBillingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds, final ApiCallback _callback) 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 = regenerateBillingRequest;
// create path and map variables
String localVarPath = "/v1/uno-regenerate/billing-transaction";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (pageSize != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("pageSize", pageSize));
}
if (reMigrate != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("reMigrate", reMigrate));
}
if (acceptEncoding != null) {
localVarHeaderParams.put("Accept-Encoding", localVarApiClient.parameterToString(acceptEncoding));
}
if (contentEncoding != null) {
localVarHeaderParams.put("Content-Encoding", localVarApiClient.parameterToString(contentEncoding));
}
if (authorization != null) {
localVarHeaderParams.put("Authorization", localVarApiClient.parameterToString(authorization));
}
if (zuoraTrackId != null) {
localVarHeaderParams.put("Zuora-Track-Id", localVarApiClient.parameterToString(zuoraTrackId));
}
if (zuoraEntityIds != null) {
localVarHeaderParams.put("Zuora-Entity-Ids", localVarApiClient.parameterToString(zuoraEntityIds));
}
if (zuoraOrgIds != null) {
localVarHeaderParams.put("Zuora-Org-Ids", localVarApiClient.parameterToString(zuoraOrgIds));
}
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "bearerAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call pOSTRegenerateBillingTransactionValidateBeforeCall(RegenerateBillingRequest regenerateBillingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'regenerateBillingRequest' is set
if (regenerateBillingRequest == null) {
throw new ApiException("Missing the required parameter 'regenerateBillingRequest' when calling pOSTRegenerateBillingTransaction(Async)");
}
return pOSTRegenerateBillingTransactionCall(regenerateBillingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds, _callback);
}
/**
* Regenerate Billing Transaction
* This call is useful in the following two use cases. * During customer onboarding, there is a common scenario where customers perform data backfill or data fixes. To synchronize these changes from billing to revenue, customers leverage the provided API to regenerate booking and billing transaction objects. * Customers choose to experiment with their use cases in the SBX environment before implementing them in production. During this experimentation phase, customers not only interact with data but also leverage the API to regenerate transaction objects.
* @param regenerateBillingRequest The request body to regenerate Billing Transaction (required)
* @param acceptEncoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. (optional)
* @param contentEncoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. (optional)
* @param authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). (optional)
* @param zuoraTrackId A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
* @param zuoraEntityIds An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
* @param page The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. (optional, default to 1)
* @param pageSize The number of records returned per page in the response. (optional, default to 20)
* @param reMigrate Indicates if existing data in the database will be overridden. (optional)
* @param zuoraOrgIds Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. (optional)
* @return RegenerateTransactionObjectResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
protected RegenerateTransactionObjectResponse pOSTRegenerateBillingTransaction(RegenerateBillingRequest regenerateBillingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds) throws ApiException {
ApiResponse localVarResp = pOSTRegenerateBillingTransactionWithHttpInfo(regenerateBillingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds);
return localVarResp.getData();
}
private ApiResponse pOSTRegenerateBillingTransactionWithHttpInfo(RegenerateBillingRequest regenerateBillingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds) throws ApiException {
okhttp3.Call localVarCall = pOSTRegenerateBillingTransactionValidateBeforeCall(regenerateBillingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private okhttp3.Call pOSTRegenerateBillingTransactionAsync(RegenerateBillingRequest regenerateBillingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = pOSTRegenerateBillingTransactionValidateBeforeCall(regenerateBillingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public class POSTRegenerateBillingTransactionApi {
private final RegenerateBillingRequest regenerateBillingRequest;
private String acceptEncoding;
private String contentEncoding;
private String authorization;
private String zuoraTrackId;
private String zuoraEntityIds;
private Integer page;
private Integer pageSize;
private Boolean reMigrate;
private String zuoraOrgIds;
private POSTRegenerateBillingTransactionApi(RegenerateBillingRequest regenerateBillingRequest) {
this.regenerateBillingRequest = regenerateBillingRequest;
}
/**
* Set acceptEncoding
* @param acceptEncoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. (optional)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi acceptEncoding(String acceptEncoding) {
this.acceptEncoding = acceptEncoding;
return this;
}
/**
* Set contentEncoding
* @param contentEncoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. (optional)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi contentEncoding(String contentEncoding) {
this.contentEncoding = contentEncoding;
return this;
}
/**
* Set authorization
* @param authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). (optional)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi authorization(String authorization) {
this.authorization = authorization;
return this;
}
/**
* Set zuoraTrackId
* @param zuoraTrackId A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi zuoraTrackId(String zuoraTrackId) {
this.zuoraTrackId = zuoraTrackId;
return this;
}
/**
* Set zuoraEntityIds
* @param zuoraEntityIds An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi zuoraEntityIds(String zuoraEntityIds) {
this.zuoraEntityIds = zuoraEntityIds;
return this;
}
/**
* Set page
* @param page The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. (optional, default to 1)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi page(Integer page) {
this.page = page;
return this;
}
/**
* Set pageSize
* @param pageSize The number of records returned per page in the response. (optional, default to 20)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi pageSize(Integer pageSize) {
this.pageSize = pageSize;
return this;
}
/**
* Set reMigrate
* @param reMigrate Indicates if existing data in the database will be overridden. (optional)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi reMigrate(Boolean reMigrate) {
this.reMigrate = reMigrate;
return this;
}
/**
* Set zuoraOrgIds
* @param zuoraOrgIds Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. (optional)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi zuoraOrgIds(String zuoraOrgIds) {
this.zuoraOrgIds = zuoraOrgIds;
return this;
}
/**
* Build call for pOSTRegenerateBillingTransaction
* @param _callback ApiCallback API callback
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
public RegenerateTransactionObjectResponse execute() throws ApiException {
ApiResponse localVarResp = pOSTRegenerateBillingTransactionWithHttpInfo(regenerateBillingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds);
return localVarResp.getData();
}
/**
* Execute pOSTRegenerateBillingTransaction request with HTTP info returned
* @return ApiResponse<RegenerateTransactionObjectResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
private ApiResponse executeWithHttpInfo() throws ApiException {
return pOSTRegenerateBillingTransactionWithHttpInfo(regenerateBillingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds);
}
/**
* Execute pOSTRegenerateBillingTransaction request (asynchronously)
* @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
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
return pOSTRegenerateBillingTransactionAsync(regenerateBillingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds, _callback);
}
}
/**
* Regenerate Billing Transaction
* This call is useful in the following two use cases. * During customer onboarding, there is a common scenario where customers perform data backfill or data fixes. To synchronize these changes from billing to revenue, customers leverage the provided API to regenerate booking and billing transaction objects. * Customers choose to experiment with their use cases in the SBX environment before implementing them in production. During this experimentation phase, customers not only interact with data but also leverage the API to regenerate transaction objects.
* @param regenerateBillingRequest The request body to regenerate Billing Transaction (required)
* @return POSTRegenerateBillingTransactionApi
*/
public POSTRegenerateBillingTransactionApi pOSTRegenerateBillingTransactionApi(RegenerateBillingRequest regenerateBillingRequest) {
return new POSTRegenerateBillingTransactionApi(regenerateBillingRequest);
}
private okhttp3.Call pOSTRegenerateBookingTransactionCall(RegenerateBookingRequest regenerateBookingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds, final ApiCallback _callback) 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 = regenerateBookingRequest;
// create path and map variables
String localVarPath = "/v1/uno-regenerate/booking-transaction";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (pageSize != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("pageSize", pageSize));
}
if (reMigrate != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("reMigrate", reMigrate));
}
if (acceptEncoding != null) {
localVarHeaderParams.put("Accept-Encoding", localVarApiClient.parameterToString(acceptEncoding));
}
if (contentEncoding != null) {
localVarHeaderParams.put("Content-Encoding", localVarApiClient.parameterToString(contentEncoding));
}
if (authorization != null) {
localVarHeaderParams.put("Authorization", localVarApiClient.parameterToString(authorization));
}
if (zuoraTrackId != null) {
localVarHeaderParams.put("Zuora-Track-Id", localVarApiClient.parameterToString(zuoraTrackId));
}
if (zuoraEntityIds != null) {
localVarHeaderParams.put("Zuora-Entity-Ids", localVarApiClient.parameterToString(zuoraEntityIds));
}
if (zuoraOrgIds != null) {
localVarHeaderParams.put("Zuora-Org-Ids", localVarApiClient.parameterToString(zuoraOrgIds));
}
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "bearerAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call pOSTRegenerateBookingTransactionValidateBeforeCall(RegenerateBookingRequest regenerateBookingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'regenerateBookingRequest' is set
if (regenerateBookingRequest == null) {
throw new ApiException("Missing the required parameter 'regenerateBookingRequest' when calling pOSTRegenerateBookingTransaction(Async)");
}
return pOSTRegenerateBookingTransactionCall(regenerateBookingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds, _callback);
}
/**
* Regenerate Booking Transaction
* This call is useful in the following two use cases. * During customer onboarding, there is a common scenario where customers perform data backfill or data fixes. To synchronize these changes from billing to revenue, customers leverage the provided API to regenerate booking and billing transaction objects. * Customers choose to experiment with their use cases in the SBX environment before implementing them in production. During this experimentation phase, customers not only interact with data but also leverage the API to regenerate transaction objects.
* @param regenerateBookingRequest The request body to regenerate Booking Transaction (required)
* @param acceptEncoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. (optional)
* @param contentEncoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. (optional)
* @param authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). (optional)
* @param zuoraTrackId A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
* @param zuoraEntityIds An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
* @param page The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. (optional, default to 1)
* @param pageSize The number of records returned per page in the response. (optional, default to 20)
* @param reMigrate Indicates if existing data in the database will be overridden. (optional)
* @param zuoraOrgIds Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. (optional)
* @return RegenerateTransactionObjectResponse
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
protected RegenerateTransactionObjectResponse pOSTRegenerateBookingTransaction(RegenerateBookingRequest regenerateBookingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds) throws ApiException {
ApiResponse localVarResp = pOSTRegenerateBookingTransactionWithHttpInfo(regenerateBookingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds);
return localVarResp.getData();
}
private ApiResponse pOSTRegenerateBookingTransactionWithHttpInfo(RegenerateBookingRequest regenerateBookingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds) throws ApiException {
okhttp3.Call localVarCall = pOSTRegenerateBookingTransactionValidateBeforeCall(regenerateBookingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private okhttp3.Call pOSTRegenerateBookingTransactionAsync(RegenerateBookingRequest regenerateBookingRequest, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, Integer page, Integer pageSize, Boolean reMigrate, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = pOSTRegenerateBookingTransactionValidateBeforeCall(regenerateBookingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public class POSTRegenerateBookingTransactionApi {
private final RegenerateBookingRequest regenerateBookingRequest;
private String acceptEncoding;
private String contentEncoding;
private String authorization;
private String zuoraTrackId;
private String zuoraEntityIds;
private Integer page;
private Integer pageSize;
private Boolean reMigrate;
private String zuoraOrgIds;
private POSTRegenerateBookingTransactionApi(RegenerateBookingRequest regenerateBookingRequest) {
this.regenerateBookingRequest = regenerateBookingRequest;
}
/**
* Set acceptEncoding
* @param acceptEncoding Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. (optional)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi acceptEncoding(String acceptEncoding) {
this.acceptEncoding = acceptEncoding;
return this;
}
/**
* Set contentEncoding
* @param contentEncoding Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. (optional)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi contentEncoding(String contentEncoding) {
this.contentEncoding = contentEncoding;
return this;
}
/**
* Set authorization
* @param authorization The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). (optional)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi authorization(String authorization) {
this.authorization = authorization;
return this;
}
/**
* Set zuoraTrackId
* @param zuoraTrackId A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi zuoraTrackId(String zuoraTrackId) {
this.zuoraTrackId = zuoraTrackId;
return this;
}
/**
* Set zuoraEntityIds
* @param zuoraEntityIds An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi zuoraEntityIds(String zuoraEntityIds) {
this.zuoraEntityIds = zuoraEntityIds;
return this;
}
/**
* Set page
* @param page The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. (optional, default to 1)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi page(Integer page) {
this.page = page;
return this;
}
/**
* Set pageSize
* @param pageSize The number of records returned per page in the response. (optional, default to 20)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi pageSize(Integer pageSize) {
this.pageSize = pageSize;
return this;
}
/**
* Set reMigrate
* @param reMigrate Indicates if existing data in the database will be overridden. (optional)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi reMigrate(Boolean reMigrate) {
this.reMigrate = reMigrate;
return this;
}
/**
* Set zuoraOrgIds
* @param zuoraOrgIds Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. (optional)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi zuoraOrgIds(String zuoraOrgIds) {
this.zuoraOrgIds = zuoraOrgIds;
return this;
}
/**
* Build call for pOSTRegenerateBookingTransaction
* @param _callback ApiCallback API callback
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
public RegenerateTransactionObjectResponse execute() throws ApiException {
ApiResponse localVarResp = pOSTRegenerateBookingTransactionWithHttpInfo(regenerateBookingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds);
return localVarResp.getData();
}
/**
* Execute pOSTRegenerateBookingTransaction request with HTTP info returned
* @return ApiResponse<RegenerateTransactionObjectResponse>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
private ApiResponse executeWithHttpInfo() throws ApiException {
return pOSTRegenerateBookingTransactionWithHttpInfo(regenerateBookingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds);
}
/**
* Execute pOSTRegenerateBookingTransaction request (asynchronously)
* @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
* Content-Encoding - * RateLimit-Limit - * RateLimit-Remaining - * RateLimit-Reset - * WWW-Authenticate - The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` * Zuora-Request-Id - * Zuora-Track-Id -
*/
public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
return pOSTRegenerateBookingTransactionAsync(regenerateBookingRequest, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, page, pageSize, reMigrate, zuoraOrgIds, _callback);
}
}
/**
* Regenerate Booking Transaction
* This call is useful in the following two use cases. * During customer onboarding, there is a common scenario where customers perform data backfill or data fixes. To synchronize these changes from billing to revenue, customers leverage the provided API to regenerate booking and billing transaction objects. * Customers choose to experiment with their use cases in the SBX environment before implementing them in production. During this experimentation phase, customers not only interact with data but also leverage the API to regenerate transaction objects.
* @param regenerateBookingRequest The request body to regenerate Booking Transaction (required)
* @return POSTRegenerateBookingTransactionApi
*/
public POSTRegenerateBookingTransactionApi pOSTRegenerateBookingTransactionApi(RegenerateBookingRequest regenerateBookingRequest) {
return new POSTRegenerateBookingTransactionApi(regenerateBookingRequest);
}
}
