• Home
• com.zuora.sdk
• zuora-sdk-java
• 3.2.0-beta.1
• source code
• FilesApi.java

×

Project download

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.zuora.api.FilesApi Maven / Gradle / Ivy

/*
 * 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.CommonErrorResponse;
import com.zuora.model.CommonResponse;
import java.io.File;
import com.zuora.model.ProxyUnauthorizedResponse;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

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

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

    public FilesApi(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 getFilesCall(String fileId, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, String zuoraVersion, 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/files/{file-id}"
            .replace("{" + "file-id" + "}", localVarApiClient.escapeString(fileId.toString()));

        List localVarQueryParams = new ArrayList();
        List localVarCollectionQueryParams = new ArrayList();
        Map localVarHeaderParams = new HashMap();
        Map localVarCookieParams = new HashMap();
        Map localVarFormParams = new HashMap();

        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 (zuoraVersion != null) {
            localVarHeaderParams.put("Zuora-Version", localVarApiClient.parameterToString(zuoraVersion));
        }

        if (zuoraOrgIds != null) {
            localVarHeaderParams.put("Zuora-Org-Ids", localVarApiClient.parameterToString(zuoraOrgIds));
        }

        final String[] localVarAccepts = {
            "application/octet-stream",
            "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, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

    @SuppressWarnings("rawtypes")
    private okhttp3.Call getFilesValidateBeforeCall(String fileId, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, String zuoraVersion, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {
        // verify the required parameter 'fileId' is set
        if (fileId == null) {
            throw new ApiException("Missing the required parameter 'fileId' when calling getFiles(Async)");
        }

        return getFilesCall(fileId, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, zuoraVersion, zuoraOrgIds, _callback);

    }

            /**
            * Retrieve a file
            * Retrieve files such as export results, invoices, and accounting period reports.  The response content type depends on the type of file that you retrieve. For example, if you retrieve an invoice PDF, the value of the `Content-Type` header in the response is `application/pdf;charset=UTF-8`.  Other content types include:  - `text/csv` for CSV files - `application/msword` for Microsoft Word files - `application/vnd.ms-excel` and `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`   for Microsoft Excel files (*.xls* and *.xlsx* respectively) - `application/zip` and `application/x-gzip` for ZIP and Gzip files respectively - `text/html` for HTML files - `text/plain` for text files  The response always contains character encoding information in the `Content-Type` header. For example, `Content-Type: application/zip;charset=UTF-8`.  **Note:** The maximum file size is 2,047 MB. If you have a data request that exceeds this limit, Zuora returns the following 403 response: `<security:max-object-size>2047MB</security:max-object-size>`. Submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a> to determine if large file optimization is an option for you. 
                * @param fileId The Zuora ID of the file to retrieve.  (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 zuoraVersion The minor version of the Zuora REST API.   (optional, default to 2024-05-20)
                * @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 File
            * @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 
  
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
                        
 400 
 Invalid input 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
                        
 401 
  
  * 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 -  
  
                        
 403 
 Unauthorized 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
                
            */
                protected File getFiles(String fileId, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, String zuoraVersion, String zuoraOrgIds) throws ApiException {
            ApiResponse localVarResp = getFilesWithHttpInfo(fileId, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, zuoraVersion, zuoraOrgIds);
                    return localVarResp.getData();
                }


    private ApiResponse getFilesWithHttpInfo(String fileId, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, String zuoraVersion, String zuoraOrgIds) throws ApiException {
        okhttp3.Call localVarCall = getFilesValidateBeforeCall(fileId, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, zuoraVersion, zuoraOrgIds, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    private okhttp3.Call getFilesAsync(String fileId, String acceptEncoding, String contentEncoding, String authorization, String zuoraTrackId, String zuoraEntityIds, String zuoraVersion, String zuoraOrgIds, final ApiCallback _callback) throws ApiException {

        okhttp3.Call localVarCall = getFilesValidateBeforeCall(fileId, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, zuoraVersion, zuoraOrgIds, _callback);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }

    public class GetFilesApi {
        private final String fileId;
        private String acceptEncoding;
        private String contentEncoding;
        private String authorization;
        private String zuoraTrackId;
        private String zuoraEntityIds;
        private String zuoraVersion;
        private String zuoraOrgIds;

        private GetFilesApi(String fileId) {
            this.fileId = fileId;
        }

        /**
         * 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 GetFilesApi
         */
        public GetFilesApi 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 GetFilesApi
         */
        public GetFilesApi 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 GetFilesApi
         */
        public GetFilesApi 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 GetFilesApi
         */
        public GetFilesApi 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 GetFilesApi
         */
        public GetFilesApi zuoraEntityIds(String zuoraEntityIds) {
            this.zuoraEntityIds = zuoraEntityIds;
            return this;
        }

        /**
         * Set zuoraVersion
         * @param zuoraVersion The minor version of the Zuora REST API.   (optional, default to 2024-05-20)
         * @return GetFilesApi
         */
        public GetFilesApi zuoraVersion(String zuoraVersion) {
            this.zuoraVersion = zuoraVersion;
            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 GetFilesApi
         */
        public GetFilesApi zuoraOrgIds(String zuoraOrgIds) {
            this.zuoraOrgIds = zuoraOrgIds;
            return this;
        }

        /**
         * Build call for getFiles
         * @param _callback ApiCallback API callback
         * @return Call to execute
         * @throws ApiException If fail to serialize the request body object
         * @http.response.details
         

            
 Status Code 
 Description 
 Response Headers 
            
 200 
  
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
            
 400 
 Invalid input 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
            
 401 
  
  * 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 -  
  
            
 403 
 Unauthorized 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
         
         */
        public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
            return getFilesCall(fileId, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, zuoraVersion, zuoraOrgIds, _callback);
        }

        /**
         * Execute getFiles request
         * @return File
         * @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 
  
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
            
 400 
 Invalid input 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
            
 401 
  
  * 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 -  
  
            
 403 
 Unauthorized 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
         
         */
        public File execute() throws ApiException {
            ApiResponse localVarResp = getFilesWithHttpInfo(fileId, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, zuoraVersion, zuoraOrgIds);
            return localVarResp.getData();
        }

        /**
         * Execute getFiles request with HTTP info returned
         * @return ApiResponse<File>
         * @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 
  
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
            
 400 
 Invalid input 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
            
 401 
  
  * 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 -  
  
            
 403 
 Unauthorized 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
         
         */
        private ApiResponse executeWithHttpInfo() throws ApiException {
            return getFilesWithHttpInfo(fileId, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, zuoraVersion, zuoraOrgIds);
        }

        /**
         * Execute getFiles 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
         

            
 Status Code 
 Description 
 Response Headers 
            
 200 
  
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
            
 400 
 Invalid input 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
            
 401 
  
  * 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 -  
  
            
 403 
 Unauthorized 
  * Content-Encoding -  
  * RateLimit-Limit -  
  * RateLimit-Remaining -  
  * RateLimit-Reset -  
  * Zuora-Request-Id -  
  * Zuora-Track-Id -  
  
         
         */
        public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
            return getFilesAsync(fileId, acceptEncoding, contentEncoding, authorization, zuoraTrackId, zuoraEntityIds, zuoraVersion, zuoraOrgIds, _callback);
        }
    }

    /**
     * Retrieve a file
     * Retrieve files such as export results, invoices, and accounting period reports.  The response content type depends on the type of file that you retrieve. For example, if you retrieve an invoice PDF, the value of the `Content-Type` header in the response is `application/pdf;charset=UTF-8`.  Other content types include:  - `text/csv` for CSV files - `application/msword` for Microsoft Word files - `application/vnd.ms-excel` and `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`   for Microsoft Excel files (*.xls* and *.xlsx* respectively) - `application/zip` and `application/x-gzip` for ZIP and Gzip files respectively - `text/html` for HTML files - `text/plain` for text files  The response always contains character encoding information in the `Content-Type` header. For example, `Content-Type: application/zip;charset=UTF-8`.  **Note:** The maximum file size is 2,047 MB. If you have a data request that exceeds this limit, Zuora returns the following 403 response: `<security:max-object-size>2047MB</security:max-object-size>`. Submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a> to determine if large file optimization is an option for you. 
     * @param fileId The Zuora ID of the file to retrieve.  (required)
     * @return GetFilesApi
     */
    public GetFilesApi getFilesApi(String fileId) {
        return new GetFilesApi(fileId);
    }
}