Typeccript SDK Samples - Files Operations
Upload Files
import { ActionHandler } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/action_handler";
import { BodyWrapper } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/body_wrapper";
import { ActionWrapper } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/action_wrapper";
import { FileBodyWrapper } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/file_body_wrapper";
import { SuccessResponse } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/success_response";
import { APIException } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/api_exception";
import {FileOperations,GetFileParam,UploadFilesParam} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/file_operations";
import { APIResponse } from "@zohocrm/typescript-sdk/routes/controllers/api_response";
import { ParameterMap } from "@zohocrm/typescript-sdk/routes/parameter_map";
import { StreamWrapper } from "@zohocrm/typescript-sdk/utils/util/stream_wrapper";
import { ActionResponse } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/action_response";
import { ResponseHandler } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/response_handler";
import * as path from "path";
import * as fs from "fs";
export class Files{
/**
* Upload Files
* This method is used to upload a file and print the response.
*/
public static async uploadFiles(absoluteFilePath: string){
//Get instance of FileOperations Class
let fileOperations: FileOperations = new FileOperations();
//Get instance of FileBodyWrapper Class that will contain the request body
let request: BodyWrapper = new BodyWrapper();
let paramInstance: ParameterMap = new ParameterMap();
await paramInstance.add(UploadFilesParam.TYPE, "inline");
/** StreamWrapper can be initialized in any of the following ways */
/**
* param 1 -> fileName
* param 2 -> Read Stream.
*/
// let streamWrapper1 = new StreamWrapper(null, fs.createReadStream("/Users/user_name/Desktop/file1.txt"));
// let streamWrapper3 = new StreamWrapper(null, fs.createReadStream("/Users/user_name/Desktop/file2.txt"));
/**
* param 1 -> fileName
* param 2 -> Read Stream
* param 3 -> Absolute File Path of the file to be attached
*/
let streamWrapper2 = new StreamWrapper(undefined, undefined, absoluteFilePath);
let files: StreamWrapper[] = [];
files.push(streamWrapper2);
//Set files to the FileBodyWrapper instance
request.setFile(files);
//Call uploadFile method that takes BodyWrapper instance and ParameterMap instance as parameter.
let response: APIResponse = await fileOperations.uploadFiles(request, paramInstance);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject: ActionHandler = response.getObject();
if(responseObject != null){
//Check if expected ActionWrapper instance is received.
if(responseObject instanceof ActionWrapper){
//Get the array of obtained action responses
let actionResponses: ActionResponse[] = responseObject.getData();
actionResponses.forEach(actionResponse => {
//Check if the request is successful
if(actionResponse instanceof SuccessResponse){
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details: Map = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
//Check if the request returned an exception
else if(actionResponse instanceof APIException){
//Get the Status
console.log("Status: " + actionResponse.getStatus().getValue());
//Get the Code
console.log("Code: " + actionResponse.getCode().getValue());
console.log("Details");
//Get the details map
let details: Map = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + actionResponse.getMessage().getValue());
}
});
}
//Check if the request returned an exception
else if(responseObject instanceof APIException){
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details: Map = responseObject.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Get File
import { ActionHandler } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/action_handler";
import { BodyWrapper } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/body_wrapper";
import { ActionWrapper } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/action_wrapper";
import { FileBodyWrapper } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/file_body_wrapper";
import { SuccessResponse } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/success_response";
import { APIException } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/api_exception";
import {FileOperations,GetFileParam,UploadFilesParam} from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/file_operations";
import { APIResponse } from "@zohocrm/typescript-sdk/routes/controllers/api_response";
import { ParameterMap } from "@zohocrm/typescript-sdk/routes/parameter_map";
import { StreamWrapper } from "@zohocrm/typescript-sdk/utils/util/stream_wrapper";
import { ActionResponse } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/action_response";
import { ResponseHandler } from "@zohocrm/typescript-sdk/core/com/zoho/crm/api/file/response_handler";
import * as path from "path";
import * as fs from "fs";
export class Files{
/**
* Get File
* This method is used to download the file with ID and write in the destinationFolder
* @param id The ID of the uploaded File.
* @param destinationFolder The absolute path of the destination folder to store the File
*/
public static async getFile(id: string, destinationFolder: string){
//example
//let id = "ae9c7cefa418aec1d6a5cc2d9ab35c3231aae3bfeef7d5e00a54b7563c0dd42b";
//let destinationFolder = "/Users/user_name/Desktop"
//Get instance of FileOperations Class
let fileOperations: FileOperations = new FileOperations();
//Get instance of ParameterMap Class
let paramInstance: ParameterMap = new ParameterMap();
//Add the id to ParameterMap instance
await paramInstance.add(GetFileParam.ID, id);
//Call getFile method that takes ParameterMap instance as parameter
let response: APIResponse = await fileOperations.getFile(paramInstance);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if([204, 304].includes(response.getStatusCode())){
console.log(response.getStatusCode() == 204? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject: ResponseHandler = response.getObject();
if(responseObject !== null){
//Check if expected FileBodyWrapper instance is received
if(responseObject instanceof FileBodyWrapper){
//Get StreamWrapper instance from the returned FileBodyWrapper instance
let streamWrapper: StreamWrapper = responseObject.getFile();
let name: string | undefined = streamWrapper.getName();
if(name !== undefined){
//Construct the file name by joining the destinationFolder and the name from StreamWrapper instance
let fileName = path.join(destinationFolder, name);
//Get the stream from StreamWrapper instance
let readStream = streamWrapper.getStream();
if(readStream !== undefined && readStream instanceof Buffer){
//Write the stream to the destination file.
fs.writeFileSync(fileName, readStream);
}
}
}
//Check if the request returned an exception
else if(responseObject instanceof APIException){
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details: Map = responseObject.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}