TypeScript SDK Samples - Related Records Operations
Get Related Records
import * as path from "path";
import * as fs from "fs";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_wrapper";
import {DelinkRecordsParam,GetRelatedRecordHeader,GetRelatedRecordsHeader,GetRelatedRecordsParam,RelatedRecordsOperations} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/related_records_operations"
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/success_response";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_wrapper";
import { FileBodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/file_body_wrapper";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { Record } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { Tag } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/tags/tag";
import { FileDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/file_details";
import { Choice } from "@zohocrm/typescript-sdk-2.0/utils/util/choice";
import { InventoryLineItems } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/inventory_line_items";
import { LineItemProduct } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_item_product";
import { LineTax } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_tax";
import { Reminder } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/reminder";
import { Participants } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/participants";
import { PricingDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/pricing_details";
import { Comment } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/comment";
import { Layout } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/layouts/layout";
import { RemindAt } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/remind_at";
import { RecurringActivity } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/recurring_activity";
import { Consent } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/consent";
import { Info } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/info";
import { StreamWrapper } from "@zohocrm/typescript-sdk-2.0/utils/util/stream_wrapper";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/body_wrapper";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_handler";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_response";
export class RelatedRecord{
/**
* Get Related Records
* This method is used to get the related list records and print the response.
* @param moduleAPIName The API Name of the module to get related records.
* @param recordId The ID of the record to be obtained.
* @param relatedListAPIName The API name of the related list
*/
public static async getRelatedRecords(moduleAPIName: string, recordId: bigint, relatedListAPIName: string){
//example
//let moduleAPIName = "Products";
// let recordId = 3409643798007n;
// let relatedListAPIName = "Price_Books";
//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
let relatedRecordsOperations: RelatedRecordsOperations = new RelatedRecordsOperations(relatedListAPIName, recordId, moduleAPIName);
//Get instance of ParameterMap Class
let paramInstance: ParameterMap = new ParameterMap();
/* Possible parameters for Get Related Records operation */
await paramInstance.add(GetRelatedRecordsParam.PAGE, 1);
await paramInstance.add(GetRelatedRecordsParam.PER_PAGE, 200);
//Get instance of HeaderMap Class
let headerInstance: HeaderMap = new HeaderMap();
/* Possible headers for Get Related Records operation */
await headerInstance.add(GetRelatedRecordsHeader.IF_MODIFIED_SINCE, new Date('October 15, 2019 05:35:32'));
//Call getRelatedRecords method that takes ParameterMap instance and HeaderMap instance as parameter
let response: APIResponse<ResponseHandler> = await relatedRecordsOperations.getRelatedRecords(paramInstance, headerInstance);
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();
//Check if expected ResponseWrapper instance is received
if(responseObject instanceof ResponseWrapper){
//Get the array of obtained
let records: Record[] = responseObject.getData();
for (let record of records) {
//Get the ID of each Record
console.log("RelatedRecord ID: " + record.getId());
//Get the createdBy User instance of each Record
let createdBy: User = record.getCreatedBy();
//Check if createdBy is not null
if(createdBy != null){
//Get the ID of the createdBy User
console.log("RelatedRecord Created By User-ID: " + createdBy.getId());
//Get the name of the createdBy User
console.log("RelatedRecord Created By User-Name: " + createdBy.getName());
//Get the Email of the createdBy User
console.log("RelatedRecord Created By User-Email: " + createdBy.getEmail());
}
//Get the CreatedTime of each Record
console.log("RelatedRecord CreatedTime: " + record.getCreatedTime());
//Get the modifiedBy User instance of each Record
let modifiedBy: User = record.getModifiedBy();
//Check if modifiedBy is not null
if(modifiedBy != null){
//Get the ID of the modifiedBy User
console.log("RelatedRecord Modified By User-ID: " + modifiedBy.getId());
//Get the name of the modifiedBy User
console.log("RelatedRecord Modified By User-Name: " + modifiedBy.getName());
//Get the Email of the modifiedBy User
console.log("RelatedRecord Modified By User-Email: " + modifiedBy.getEmail());
}
//Get the ModifiedTime of each Record
console.log("RelatedRecord ModifiedTime: " + record.getModifiedTime());
//Get the list of Tag instance each Record
let tags: Tag[] = record.getTag();
//Check if tags is not null
if(tags != null){
tags.forEach(tag => {
//Get the Name of each Tag
console.log("RelatedRecord Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("RelatedRecord Tag ID: " + tag.getId());
});
}
//To get particular field value
console.log("RelatedRecord Field Value: " + record.getKeyValue("Last_Name"));// FieldApiName
console.log("RelatedRecord KeyValues: " );
let keyValues: Map<string,any> = record.getKeyValues();
let keyArray: string[] = Array.from(keyValues.keys());
for (let keyName of keyArray) {
let value: any = keyValues.get(keyName);
if(Array.isArray(value)){
if(value.length > 0){
if(value[0] instanceof FileDetails){
let fileDetails: FileDetails[] = value;
fileDetails.forEach(fileDetail => {
//Get the Extn of each FileDetails
console.log("RelatedRecord FileDetails Extn: " + fileDetail.getExtn());
//Get the IsPreviewAvailable of each FileDetails
console.log("RelatedRecord FileDetails IsPreviewAvailable: " + fileDetail.getIsPreviewAvailable());
//Get the DownloadUrl of each FileDetails
console.log("RelatedRecord FileDetails DownloadUrl: " + fileDetail.getDownloadUrl());
//Get the DeleteUrl of each FileDetails
console.log("RelatedRecord FileDetails DeleteUrl: " + fileDetail.getDeleteUrl());
//Get the EntityId of each FileDetails
console.log("RelatedRecord FileDetails EntityId: " + fileDetail.getEntityId());
//Get the Mode of each FileDetails
console.log("RelatedRecord FileDetails Mode: " + fileDetail.getMode());
//Get the OriginalSizeByte of each FileDetails
console.log("RelatedRecord FileDetails OriginalSizeByte: " + fileDetail.getOriginalSizeByte());
//Get the PreviewUrl of each FileDetails
console.log("RelatedRecord FileDetails PreviewUrl: " + fileDetail.getPreviewUrl());
//Get the FileName of each FileDetails
console.log("RelatedRecord FileDetails FileName: " + fileDetail.getFileName());
//Get the FileId of each FileDetails
console.log("RelatedRecord FileDetails FileId: " + fileDetail.getFileId());
//Get the AttachmentId of each FileDetails
console.log("RelatedRecord FileDetails AttachmentId: " + fileDetail.getAttachmentId());
//Get the FileSize of each FileDetails
console.log("RelatedRecord FileDetails FileSize: " + fileDetail.getFileSize());
//Get the CreatorId of each FileDetails
console.log("RelatedRecord FileDetails CreatorId: " + fileDetail.getCreatorId());
//Get the LinkDocs of each FileDetails
console.log("RelatedRecord FileDetails LinkDocs: " + fileDetail.getLinkDocs());
});
}
else if(value[0] instanceof Choice){
let choiceArray: Choice<any>[] = value;
console.log(keyName);
console.log("Values");
choiceArray.forEach(eachChoice => {
console.log(eachChoice.getValue());
});
}
else if(value[0] instanceof InventoryLineItems){
let productDetails: InventoryLineItems[] = value;
productDetails.forEach(productDetail => {
let lineItemProduct: LineItemProduct = productDetail.getProduct();
if(lineItemProduct != null){
console.log("RelatedRecord ProductDetails LineItemProduct ProductCode: " + lineItemProduct.getProductCode());
console.log("RelatedRecord ProductDetails LineItemProduct Currency: " + lineItemProduct.getCurrency());
console.log("RelatedRecord ProductDetails LineItemProduct Name: " + lineItemProduct.getName());
console.log("RelatedRecord ProductDetails LineItemProduct Id: " + lineItemProduct.getId());
}
console.log("RelatedRecord ProductDetails Quantity: " + productDetail.getQuantity().toString());
console.log("RelatedRecord ProductDetails Discount: " + productDetail.getDiscount());
console.log("RelatedRecord ProductDetails TotalAfterDiscount: " + productDetail.getTotalAfterDiscount().toString());
console.log("RelatedRecord ProductDetails NetTotal: " + productDetail.getNetTotal().toString());
if(productDetail.getBook() != null){
console.log("RelatedRecord ProductDetails Book: " + productDetail.getBook().toString());
}
console.log("RelatedRecord ProductDetails Tax: " + productDetail.getTax().toString());
console.log("RelatedRecord ProductDetails ListPrice: " + productDetail.getListPrice().toString());
console.log("RelatedRecord ProductDetails UnitPrice: " + productDetail.getUnitPrice().toString());
console.log("RelatedRecord ProductDetails QuantityInStock: " + productDetail.getQuantityInStock().toString());
console.log("RelatedRecord ProductDetails Total: " + productDetail.getTotal().toString());
console.log("RelatedRecord ProductDetails ID: " + productDetail.getId());
console.log("RelatedRecord ProductDetails ProductDescription: " + productDetail.getProductDescription());
let lineTaxes: LineTax[] = productDetail.getLineTax();
lineTaxes.forEach(lineTax => {
console.log("RelatedRecord ProductDetails LineTax Percentage: " + lineTax.getPercentage().toString());
console.log("RelatedRecord ProductDetails LineTax Name: " + lineTax.getName());
console.log("RelatedRecord ProductDetails LineTax Id: " + lineTax.getId());
console.log("RelatedRecord ProductDetails LineTax Value: " + lineTax.getValue().toString());
});
});
}
else if(value[0] instanceof Tag){
let tags: Tag[] = value;
tags.forEach(tag => {
//Get the Name of each Tag
console.log("RelatedRecord Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("RelatedRecord Tag ID: " + tag.getId());
});
}
else if(value[0] instanceof Reminder){
let reminders: Reminder[] = value;
reminders.forEach(reminder => {
console.log("Reminder Period: "+ reminder.getPeriod());
console.log("Reminder Unit: " + reminder.getUnit());
});
}
else if(value[0] instanceof Participants){
let participants: Participants[] = value;
participants.forEach(participant => {
console.log("Record Participants Name: " + participant.getName());
console.log("Record Participants Invited: " + participant.getInvited().toString());
console.log("Record Participants ID: " + participant.getId());
console.log("Record Participants Type: " + participant.getType());
console.log("Record Participants Participant: " + participant.getParticipant());
console.log("Record Participants Status: " + participant.getStatus());
});
}
else if(value[0] instanceof PricingDetails){
let pricingDetails: PricingDetails[] = value;
pricingDetails.forEach(pricingDetail => {
console.log("RelatedRecord PricingDetails ToRange: " + pricingDetail.getToRange().toString());
console.log("RelatedRecord PricingDetails Discount: " + pricingDetail.getDiscount().toString());
console.log("RelatedRecord PricingDetails ID: " + pricingDetail.getId());
console.log("RelatedRecord PricingDetails FromRange: " + pricingDetail.getFromRange().toString());
});
}
else if(value[0] instanceof Record){
let recordArray: Record[] = value;
recordArray.forEach(record => {
Array.from(record.getKeyValues().keys()).forEach(key => {
console.log(key + ": " + record.getKeyValues().get(key));
});
});
}
else if(value[0] instanceof Reminder){
let reminders: Reminder[] = value;
reminders.forEach(reminder => {
console.log("Reminder Period: "+ reminder.getPeriod());
console.log("Reminder Unit: " + reminder.getUnit());
});
}
else if(value[0] instanceof LineTax){
let lineTaxes: LineTax[] = value;
lineTaxes.forEach(lineTax => {
console.log("RelatedRecord ProductDetails LineTax Percentage: " + lineTax.getPercentage().toString());
console.log("RelatedRecord ProductDetails LineTax Name: " + lineTax.getName());
console.log("RelatedRecord ProductDetails LineTax Id: " + lineTax.getId());
console.log("RelatedRecord ProductDetails LineTax Value: " + lineTax.getValue().toString());
});
}
else if(value[0] instanceof Comment) {
let comments: Comment[] = value;
comments.forEach(comment => {
console.log("Record Comment CommentedBy: " + comment.getCommentedBy());
console.log("Record Comment CommentedTime: " + comment.getCommentedTime().toString());
console.log("Record Comment CommentContent: " + comment.getCommentContent());
console.log("Record Comment Id: " + comment.getId());
});
}
else{
console.log(keyName + ": " + value);
}
}
}
else if(value instanceof Layout){
console.log(keyName + " ID: " + value.getId());
console.log(keyName + " Name: " + value.getName());
}
else if(value instanceof User){
console.log("RelatedRecord " + keyName + " User-ID: " + value.getId());
console.log("RelatedRecord " + keyName + " User-Name: " + value.getName());
console.log("RelatedRecord " + keyName + " User-Email: " + value.getEmail());
}
else if(value instanceof Choice){
console.log(keyName + ": " + value.getValue());
}
else if(value instanceof RemindAt){
console.log(keyName + ": " + value.getAlarm());
}
else if(value instanceof Record){
console.log(keyName + " Record ID: " + value.getId());
console.log(keyName + " Record Name: " + value.getKeyValue("name"));
}
else if(value instanceof RecurringActivity){
console.log(keyName);
console.log("RRULE: " + value.getRrule());
}
else if(value instanceof Consent) {
console.log("Record Consent ID: " + value.getId());
//Get the Owner User instance of each attachment
let owner: User = value.getOwner();
//Check if owner is not null
if(owner != null) {
//Get the name of the owner User
console.log("Record Consent Owner Name: " + owner.getName());
//Get the ID of the owner User
console.log("Record Consent Owner ID: " + owner.getId());
//Get the Email of the owner User
console.log("Record Consent Owner Email: " + owner.getEmail());
}
let consentCreatedBy: User = value.getCreatedBy();
//Check if createdBy is not null
if(consentCreatedBy != null) {
//Get the name of the CreatedBy User
console.log("Record Consent CreatedBy Name: " + consentCreatedBy.getName());
//Get the ID of the CreatedBy User
console.log("Record Consent CreatedBy ID: " + consentCreatedBy.getId());
//Get the Email of the CreatedBy User
console.log("Record Consent CreatedBy Email: " + consentCreatedBy.getEmail());
}
let consentModifiedBy: User = value.getModifiedBy();
//Check if createdBy is not null
if(consentModifiedBy != null) {
//Get the name of the ModifiedBy User
console.log("Record Consent ModifiedBy Name: " + consentModifiedBy.getName());
//Get the ID of the ModifiedBy User
console.log("Record Consent ModifiedBy ID: " + consentModifiedBy.getId());
//Get the Email of the ModifiedBy User
console.log("Record Consent ModifiedBy Email: " + consentModifiedBy.getEmail());
}
console.log("Record Consent CreatedTime: " + value.getCreatedTime());
console.log("Record Consent ModifiedTime: " + value.getModifiedTime());
console.log("Record Consent ContactThroughEmail: " + value.getContactThroughEmail());
console.log("Record Consent ContactThroughSocial: " + value.getContactThroughSocial());
console.log("Record Consent ContactThroughSurvey: " + value.getContactThroughSurvey());
console.log("Record Consent ContactThroughPhone: " + value.getContactThroughPhone());
console.log("Record Consent MailSentTime: " + value.getMailSentTime().toString());
console.log("Record Consent ConsentDate: " + value.getConsentDate().toString());
console.log("Record Consent ConsentRemarks: " + value.getConsentRemarks());
console.log("Record Consent ConsentThrough: " + value.getConsentThrough());
console.log("Record Consent DataProcessingBasis: " + value.getDataProcessingBasis());
//To get custom values
console.log("Record Consent Lawful Reason: " + value.getKeyValue("Lawful_Reason"));
}
else if(value instanceof Map){
console.log(keyName);
Array.from(value.keys()).forEach(key => {
console.log(key + ": " + value.get(key));
});
}
else{
console.log(keyName + ": " + value);
}
}
}
//Get the obtained Info Object
let info: Info = responseObject.getInfo();
if(info != null){
if(info.getPerPage() != null){
//Get the PerPage of the Info
console.log("RelatedRecord Info PerPage: " + info.getPerPage().toString());
}
if(info.getCount() != null){
//Get the Count of the Info
console.log("RelatedRecord Info Count: " + info.getCount().toString());
}
if(info.getPage() != null){
//Get the Page of the Info
console.log("RelatedRecord Info Page: " + info.getPage().toString());
}
if(info.getMoreRecords() != null){
//Get the MoreRecords of the Info
console.log("RelatedRecord Info MoreRecords: " + info.getMoreRecords().toString());
}
}
}
//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<string,any> = 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());
}
}
}
}
Update Related Records
import * as path from "path";
import * as fs from "fs";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_wrapper";
import {DelinkRecordsParam,GetRelatedRecordHeader,GetRelatedRecordsHeader,GetRelatedRecordsParam,RelatedRecordsOperations} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/related_records_operations"
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/success_response";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_wrapper";
import { FileBodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/file_body_wrapper";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { Record } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { Tag } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/tags/tag";
import { FileDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/file_details";
import { Choice } from "@zohocrm/typescript-sdk-2.0/utils/util/choice";
import { InventoryLineItems } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/inventory_line_items";
import { LineItemProduct } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_item_product";
import { LineTax } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_tax";
import { Reminder } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/reminder";
import { Participants } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/participants";
import { PricingDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/pricing_details";
import { Comment } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/comment";
import { Layout } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/layouts/layout";
import { RemindAt } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/remind_at";
import { RecurringActivity } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/recurring_activity";
import { Consent } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/consent";
import { Info } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/info";
import { StreamWrapper } from "@zohocrm/typescript-sdk-2.0/utils/util/stream_wrapper";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/body_wrapper";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_handler";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_response";
export class RelatedRecord{
/**
* Update Related Record
* This method is used to update the relation between the records and print the response.
* @param moduleAPIName The API Name of the module to update related record.
* @param recordId The ID of the record to be update Related List.
* @param relatedListAPIName The API name of the related list.
*/
public static async updateRelatedRecords(moduleAPIName: string, recordId: bigint, relatedListAPIName: string){
//example
//let moduleAPIName = "Products";
// let recordId = 3409643798007n;
// let relatedModuleAPIName = "Price_Books";
//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
let relatedRecordsOperations: RelatedRecordsOperations = new RelatedRecordsOperations(relatedListAPIName, recordId, moduleAPIName);
//Get instance of BodyWrapper Class that will contain the request body
let request: BodyWrapper = new BodyWrapper();
//Array to hold Record instances
let recordsArray: Record[] = [];
//Get instance of Record Class
let record1: Record = new Record();
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record1.setId(BigInt("34770617246019"));
record1.addKeyValue("list_price", 50.59);
//Add Record instance to the array
recordsArray.push(record1);
let record2: Record = new Record();
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record2.addKeyValue("id", BigInt("34096432414001"));
record2.addKeyValue("list_price", 100.56);
//Add Record instance to the array
recordsArray.push(record2);
//Set the array to Records in BodyWrapper instance
request.setData(recordsArray);
//Call updateRelatedRecords method that takes BodyWrapper instance
let response: APIResponse<ActionHandler> = await relatedRecordsOperations.updateRelatedRecords(request);
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 ActionResponse instances
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<string,any> = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
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<string,any> = 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<string,any> = 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());
}
}
}
}
}
Delink Records
import * as path from "path";
import * as fs from "fs";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_wrapper";
import {DelinkRecordsParam,GetRelatedRecordHeader,GetRelatedRecordsHeader,GetRelatedRecordsParam,RelatedRecordsOperations} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/related_records_operations"
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/success_response";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_wrapper";
import { FileBodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/file_body_wrapper";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { Record } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { Tag } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/tags/tag";
import { FileDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/file_details";
import { Choice } from "@zohocrm/typescript-sdk-2.0/utils/util/choice";
import { InventoryLineItems } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/inventory_line_items";
import { LineItemProduct } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_item_product";
import { LineTax } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_tax";
import { Reminder } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/reminder";
import { Participants } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/participants";
import { PricingDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/pricing_details";
import { Comment } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/comment";
import { Layout } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/layouts/layout";
import { RemindAt } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/remind_at";
import { RecurringActivity } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/recurring_activity";
import { Consent } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/consent";
import { Info } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/info";
import { StreamWrapper } from "@zohocrm/typescript-sdk-2.0/utils/util/stream_wrapper";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/body_wrapper";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_handler";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_response";
export class RelatedRecord{
/**
* Delink Records
* This method is used to delete the association between modules and print the response.
* @param moduleAPIName The API Name of the module to delink related records.
* @param recordId The ID of the record
* @param relatedListAPIName The API name of the related list
* @param relatedListIds The array of related record IDs.
*/
public static async deLinkRecords(moduleAPIName: string, recordId: bigint, relatedListAPIName: string, relatedListIds: bigint[]){
//example
// let moduleAPIName = "Products";
// let recordId = 3409643798007n;
// let relatedModuleAPIName = "Price_Books";
// let relatedIds = [34096432414001n, 34096432414002n, 34096432414020n];
//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
let relatedRecordsOperations: RelatedRecordsOperations = new RelatedRecordsOperations(relatedListAPIName, recordId, moduleAPIName);
//Get instance of ParameterMap Class
let paramInstance: ParameterMap = new ParameterMap();
/* Possible parameters of Delink Records operation */
for(let relatedListId of relatedListIds) {
await paramInstance.add(DelinkRecordsParam.IDS, relatedListId);
}
//Call delinkRecords method that takes ParameterMap instance as parameter.
let response: APIResponse<ActionHandler> = await relatedRecordsOperations.delinkRecords(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 ActionResponse instances
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<string,any> = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
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<string,any> = 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<string,any> = 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 a Related Record
import * as path from "path";
import * as fs from "fs";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_wrapper";
import {DelinkRecordsParam,GetRelatedRecordHeader,GetRelatedRecordsHeader,GetRelatedRecordsParam,RelatedRecordsOperations} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/related_records_operations"
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/success_response";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_wrapper";
import { FileBodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/file_body_wrapper";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { Record } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { Tag } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/tags/tag";
import { FileDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/file_details";
import { Choice } from "@zohocrm/typescript-sdk-2.0/utils/util/choice";
import { InventoryLineItems } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/inventory_line_items";
import { LineItemProduct } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_item_product";
import { LineTax } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_tax";
import { Reminder } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/reminder";
import { Participants } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/participants";
import { PricingDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/pricing_details";
import { Comment } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/comment";
import { Layout } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/layouts/layout";
import { RemindAt } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/remind_at";
import { RecurringActivity } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/recurring_activity";
import { Consent } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/consent";
import { Info } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/info";
import { StreamWrapper } from "@zohocrm/typescript-sdk-2.0/utils/util/stream_wrapper";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/body_wrapper";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_handler";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_response";
export class RelatedRecord{
/**
* Get Related Record
* This method is used to get the single related list record and print the response.
* @param moduleAPIName The API Name of the module to get related record.
* @param recordId The ID of the record to be get Related List.
* @param relatedistAPIName The API name of the related list.
* @param relatedListId The ID of the related record.
* @param destinationFolder The absolute path of the folder to store the obtained file
*/
public static async getRelatedRecord(moduleAPIName: string, recordId: bigint, relatedListAPIName: string, relatedListId: bigint, destinationFolder: string){
//example
// let moduleAPIName = "Products";
// let recordId = 3409643798007n;
// let relatedModuleAPIName = "Price_Books";
// let relatedListId = 34096432414001n;
//let destinationFolder = "/Users/user/Desktop"
//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
let relatedRecordsOperations: RelatedRecordsOperations = new RelatedRecordsOperations(relatedListAPIName, recordId, moduleAPIName);
//Get instance of HeaderMap Class
let headerInstance: HeaderMap = new HeaderMap();
/* Possible parameters for Get Related Record operation */
await headerInstance.add(GetRelatedRecordHeader.IF_MODIFIED_SINCE, new Date('June 15, 2020 05:35:32'));
//Call getRelatedRecord method that takes headerInstance and relatedRecordId as parameter
let response: APIResponse<ResponseHandler> = await relatedRecordsOperations.getRelatedRecord(relatedListId, headerInstance);
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();
//Check if ResponseWrapper instance is received
if(responseObject instanceof ResponseWrapper){
//Get the array of obtained Record instances
let records: Record[] = responseObject.getData();
for (let record of records) {
//Get the ID of each Record
console.log("RelatedRecord ID: " + record.getId());
//Get the createdBy User instance of each Record
let createdBy: User = record.getCreatedBy();
//Check if createdBy is not null
if(createdBy != null){
//Get the ID of the createdBy User
console.log("RelatedRecord Created By User-ID: " + createdBy.getId());
//Get the name of the createdBy User
console.log("RelatedRecord Created By User-Name: " + createdBy.getName());
//Get the Email of the createdBy User
console.log("RelatedRecord Created By User-Email: " + createdBy.getEmail());
}
//Get the CreatedTime of each Record
console.log("RelatedRecord CreatedTime: " + record.getCreatedTime());
//Get the modifiedBy User instance of each Record
let modifiedBy: User = record.getModifiedBy();
//Check if modifiedBy is not null
if(modifiedBy != null){
//Get the ID of the modifiedBy User
console.log("RelatedRecord Modified By User-ID: " + modifiedBy.getId());
//Get the name of the modifiedBy User
console.log("RelatedRecord Modified By User-Name: " + modifiedBy.getName());
//Get the Email of the modifiedBy User
console.log("RelatedRecord Modified By User-Email: " + modifiedBy.getEmail());
}
//Get the ModifiedTime of each Record
console.log("RelatedRecord ModifiedTime: " + record.getModifiedTime());
//Get the list of Tag instance each Record
let tags: Tag[] = record.getTag();
//Check if tags is not null
if(tags != null){
tags.forEach(tag => {
//Get the Name of each Tag
console.log("RelatedRecord Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("RelatedRecord Tag ID: " + tag.getId());
});
}
//To get particular field value
console.log("RelatedRecord Field Value: " + record.getKeyValue("Last_Name"));// FieldApiName
console.log("RelatedRecord KeyValues: " );
let keyValues: Map<string,any> = record.getKeyValues();
let keyArray: string[] = Array.from(keyValues.keys());
for (let keyName of keyArray) {
let value: any = keyValues.get(keyName);
if(Array.isArray(value)){
if(value.length > 0){
if(value[0] instanceof FileDetails){
let fileDetails: FileDetails[] = value;
fileDetails.forEach(fileDetail => {
//Get the Extn of each FileDetails
console.log("RelatedRecord FileDetails Extn: " + fileDetail.getExtn());
//Get the IsPreviewAvailable of each FileDetails
console.log("RelatedRecord FileDetails IsPreviewAvailable: " + fileDetail.getIsPreviewAvailable());
//Get the DownloadUrl of each FileDetails
console.log("RelatedRecord FileDetails DownloadUrl: " + fileDetail.getDownloadUrl());
//Get the DeleteUrl of each FileDetails
console.log("RelatedRecord FileDetails DeleteUrl: " + fileDetail.getDeleteUrl());
//Get the EntityId of each FileDetails
console.log("RelatedRecord FileDetails EntityId: " + fileDetail.getEntityId());
//Get the Mode of each FileDetails
console.log("RelatedRecord FileDetails Mode: " + fileDetail.getMode());
//Get the OriginalSizeByte of each FileDetails
console.log("RelatedRecord FileDetails OriginalSizeByte: " + fileDetail.getOriginalSizeByte());
//Get the PreviewUrl of each FileDetails
console.log("RelatedRecord FileDetails PreviewUrl: " + fileDetail.getPreviewUrl());
//Get the FileName of each FileDetails
console.log("RelatedRecord FileDetails FileName: " + fileDetail.getFileName());
//Get the FileId of each FileDetails
console.log("RelatedRecord FileDetails FileId: " + fileDetail.getFileId());
//Get the AttachmentId of each FileDetails
console.log("RelatedRecord FileDetails AttachmentId: " + fileDetail.getAttachmentId());
//Get the FileSize of each FileDetails
console.log("RelatedRecord FileDetails FileSize: " + fileDetail.getFileSize());
//Get the CreatorId of each FileDetails
console.log("RelatedRecord FileDetails CreatorId: " + fileDetail.getCreatorId());
//Get the LinkDocs of each FileDetails
console.log("RelatedRecord FileDetails LinkDocs: " + fileDetail.getLinkDocs());
});
}
else if(value[0] instanceof Choice){
let choiceArray: Choice<any>[] = value;
console.log(keyName);
console.log("Values");
choiceArray.forEach(eachChoice => {
console.log(eachChoice.getValue());
});
}
else if(value[0] instanceof InventoryLineItems){
let productDetails: InventoryLineItems[] = value;
productDetails.forEach(productDetail => {
let lineItemProduct: LineItemProduct = productDetail.getProduct();
if(lineItemProduct != null){
console.log("RelatedRecord ProductDetails LineItemProduct ProductCode: " + lineItemProduct.getProductCode());
console.log("RelatedRecord ProductDetails LineItemProduct Currency: " + lineItemProduct.getCurrency());
console.log("RelatedRecord ProductDetails LineItemProduct Name: " + lineItemProduct.getName());
console.log("RelatedRecord ProductDetails LineItemProduct Id: " + lineItemProduct.getId());
}
console.log("RelatedRecord ProductDetails Quantity: " + productDetail.getQuantity().toString());
console.log("RelatedRecord ProductDetails Discount: " + productDetail.getDiscount());
console.log("RelatedRecord ProductDetails TotalAfterDiscount: " + productDetail.getTotalAfterDiscount().toString());
console.log("RelatedRecord ProductDetails NetTotal: " + productDetail.getNetTotal().toString());
if(productDetail.getBook() != null){
console.log("RelatedRecord ProductDetails Book: " + productDetail.getBook().toString());
}
console.log("RelatedRecord ProductDetails Tax: " + productDetail.getTax().toString());
console.log("RelatedRecord ProductDetails ListPrice: " + productDetail.getListPrice().toString());
console.log("RelatedRecord ProductDetails UnitPrice: " + productDetail.getUnitPrice().toString());
console.log("RelatedRecord ProductDetails QuantityInStock: " + productDetail.getQuantityInStock().toString());
console.log("RelatedRecord ProductDetails Total: " + productDetail.getTotal().toString());
console.log("RelatedRecord ProductDetails ID: " + productDetail.getId());
console.log("RelatedRecord ProductDetails ProductDescription: " + productDetail.getProductDescription());
let lineTaxes: LineTax[] = productDetail.getLineTax();
lineTaxes.forEach(lineTax => {
console.log("RelatedRecord ProductDetails LineTax Percentage: " + lineTax.getPercentage().toString());
console.log("RelatedRecord ProductDetails LineTax Name: " + lineTax.getName());
console.log("RelatedRecord ProductDetails LineTax Id: " + lineTax.getId());
console.log("RelatedRecord ProductDetails LineTax Value: " + lineTax.getValue().toString());
});
});
}
else if(value[0] instanceof Tag){
let tags: Tag[] = value;
tags.forEach(tag => {
//Get the Name of each Tag
console.log("RelatedRecord Tag Name: " + tag.getName());
//Get the Id of each Tag
console.log("RelatedRecord Tag ID: " + tag.getId());
});
}
else if(value[0] instanceof Reminder){
let reminders: Reminder[] = value;
reminders.forEach(reminder => {
console.log("Reminder Period: "+ reminder.getPeriod());
console.log("Reminder Unit: " + reminder.getUnit());
});
}
else if(value[0] instanceof PricingDetails){
let pricingDetails: PricingDetails[] = value;
pricingDetails.forEach(pricingDetail => {
console.log("RelatedRecord PricingDetails ToRange: " + pricingDetail.getToRange().toString());
console.log("RelatedRecord PricingDetails Discount: " + pricingDetail.getDiscount().toString());
console.log("RelatedRecord PricingDetails ID: " + pricingDetail.getId());
console.log("RelatedRecord PricingDetails FromRange: " + pricingDetail.getFromRange().toString());
});
}
else if(value[0] instanceof Record){
let recordArray: Record[] = value;
recordArray.forEach(record => {
Array.from(record.getKeyValues().keys()).forEach(key => {
console.log(key + ": " + record.getKeyValues().get(key));
});
});
}
else if(value[0] instanceof LineTax){
let lineTaxes: LineTax[] = value;
lineTaxes.forEach(lineTax => {
console.log("RelatedRecord ProductDetails LineTax Percentage: " + lineTax.getPercentage().toString());
console.log("RelatedRecord ProductDetails LineTax Name: " + lineTax.getName());
console.log("RelatedRecord ProductDetails LineTax Id: " + lineTax.getId());
console.log("RelatedRecord ProductDetails LineTax Value: " + lineTax.getValue().toString());
});
}
else if(value[0] instanceof Comment) {
let comments: Comment[] = value;
comments.forEach(comment => {
console.log("Record Comment CommentedBy: " + comment.getCommentedBy());
console.log("Record Comment CommentedTime: " + comment.getCommentedTime().toString());
console.log("Record Comment CommentContent: " + comment.getCommentContent());
console.log("Record Comment Id: " + comment.getId());
});
}
else{
console.log(keyName + ": " + value);
}
}
}
else if(value instanceof Record){
console.log(keyName + " Record ID: " + value.getId());
console.log(keyName + " Record Name: " + value.getKeyValue("name"));
}
else if(value instanceof Layout){
console.log(keyName + " ID: " + value.getId());
console.log(keyName + " Name: " + value.getName());
}
else if(value instanceof User){
console.log("RelatedRecord " + keyName + " User-ID: " + value.getId());
console.log("RelatedRecord " + keyName + " User-Name: " + value.getName());
console.log("RelatedRecord " + keyName + " User-Email: " + value.getEmail());
}
else if(value instanceof Choice){
console.log(keyName + ": " + value.getValue());
}
else if(value instanceof RemindAt){
console.log(keyName + ": " + value.getAlarm());
}
else if(value instanceof RecurringActivity){
console.log(keyName);
console.log("RRULE: " + value.getRrule());
}
else if(value instanceof Consent) {
console.log("Record Consent ID: " + value.getId());
//Get the Owner User instance of each attachment
let owner: User = value.getOwner();
//Check if owner is not null
if(owner != null) {
//Get the name of the owner User
console.log("Record Consent Owner Name: " + owner.getName());
//Get the ID of the owner User
console.log("Record Consent Owner ID: " + owner.getId());
//Get the Email of the owner User
console.log("Record Consent Owner Email: " + owner.getEmail());
}
let consentCreatedBy: User = value.getCreatedBy();
//Check if createdBy is not null
if(consentCreatedBy != null) {
//Get the name of the CreatedBy User
console.log("Record Consent CreatedBy Name: " + consentCreatedBy.getName());
//Get the ID of the CreatedBy User
console.log("Record Consent CreatedBy ID: " + consentCreatedBy.getId());
//Get the Email of the CreatedBy User
console.log("Record Consent CreatedBy Email: " + consentCreatedBy.getEmail());
}
let consentModifiedBy: User = value.getModifiedBy();
//Check if createdBy is not null
if(consentModifiedBy != null) {
//Get the name of the ModifiedBy User
console.log("Record Consent ModifiedBy Name: " + consentModifiedBy.getName());
//Get the ID of the ModifiedBy User
console.log("Record Consent ModifiedBy ID: " + consentModifiedBy.getId());
//Get the Email of the ModifiedBy User
console.log("Record Consent ModifiedBy Email: " + consentModifiedBy.getEmail());
}
console.log("Record Consent CreatedTime: " + value.getCreatedTime());
console.log("Record Consent ModifiedTime: " + value.getModifiedTime());
console.log("Record Consent ContactThroughEmail: " + value.getContactThroughEmail());
console.log("Record Consent ContactThroughSocial: " + value.getContactThroughSocial());
console.log("Record Consent ContactThroughSurvey: " + value.getContactThroughSurvey());
console.log("Record Consent ContactThroughPhone: " + value.getContactThroughPhone());
console.log("Record Consent MailSentTime: " + value.getMailSentTime().toString());
console.log("Record Consent ConsentDate: " + value.getConsentDate().toString());
console.log("Record Consent ConsentRemarks: " + value.getConsentRemarks());
console.log("Record Consent ConsentThrough: " + value.getConsentThrough());
console.log("Record Consent DataProcessingBasis: " + value.getDataProcessingBasis());
//To get custom values
console.log("Record Consent Lawful Reason: " + value.getKeyValue("Lawful_Reason"));
}
else if(value instanceof Map){
console.log(keyName);
Array.from(value.keys()).forEach(key => {
console.log(key + ": " + value.get(key));
});
}
else{
console.log(keyName + ": " + value);
}
}
}
}
//Check if expected FileBodyWrapper instance is received
else 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<string,any> = 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());
}
}
}
}
Update a Related Record
import * as path from "path";
import * as fs from "fs";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_wrapper";
import {DelinkRecordsParam,GetRelatedRecordHeader,GetRelatedRecordsHeader,GetRelatedRecordsParam,RelatedRecordsOperations} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/related_records_operations"
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/success_response";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_wrapper";
import { FileBodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/file_body_wrapper";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { Record } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { Tag } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/tags/tag";
import { FileDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/file_details";
import { Choice } from "@zohocrm/typescript-sdk-2.0/utils/util/choice";
import { InventoryLineItems } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/inventory_line_items";
import { LineItemProduct } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_item_product";
import { LineTax } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_tax";
import { Reminder } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/reminder";
import { Participants } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/participants";
import { PricingDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/pricing_details";
import { Comment } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/comment";
import { Layout } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/layouts/layout";
import { RemindAt } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/remind_at";
import { RecurringActivity } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/recurring_activity";
import { Consent } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/consent";
import { Info } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/info";
import { StreamWrapper } from "@zohocrm/typescript-sdk-2.0/utils/util/stream_wrapper";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/body_wrapper";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_handler";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_response";
export class RelatedRecord{
/**
* Update Related Record
* This method is used to update the relation between the records and print the response.
* @param moduleAPIName The API Name of the module to get related record.
* @param recordId The ID of the record to be get Related List.
* @param relatedListAPIName The API name of the related list.
* @param relatedListId The ID of the related record.
*/
public static async updateRelatedRecord(moduleAPIName: string, recordId: bigint, relatedListAPIName: string, relatedListId: bigint){
//example
// let moduleAPIName = "Products";
// let recordId = 3409643798007n;
// let relatedModuleAPIName = "Price_Books";
// let relatedId = 34096432414001n;
//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
let relatedRecordsOperations: RelatedRecordsOperations = new RelatedRecordsOperations(relatedListAPIName, recordId, moduleAPIName);
//Get instance of BodyWrapper Class that will contain the request body
let request: BodyWrapper = new BodyWrapper();
//Array to hold Record instances
let recordsArray: Record[] = [];
//Get instance of Record class
let record1: Record = new Record();
/*
* Call addKeyValue method that takes two arguments
* 1 -> A string that is the Field's API Name
* 2 -> Value
*/
record1.addKeyValue("list_price", 50.56);
//Add the record to array
recordsArray.push(record1);
//Set the array to data of BodyWrapper instance
request.setData(recordsArray);
//Call updateRelatedRecord method that takes BodyWrapper instance, relatedRecordId as parameter.
let response: APIResponse<ActionHandler> = await relatedRecordsOperations.updateRelatedRecord(relatedListId, request);
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 ActionResponse instances
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<string,any> = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
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<string,any> = 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<string,any> = 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());
}
}
}
}
}
Delink a Record
import * as path from "path";
import * as fs from "fs";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_wrapper";
import {DelinkRecordsParam,GetRelatedRecordHeader,GetRelatedRecordsHeader,GetRelatedRecordsParam,RelatedRecordsOperations} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/related_records_operations"
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/response_handler";
import { APIException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/api_exception";
import { SuccessResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/success_response";
import { ActionWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_wrapper";
import { FileBodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/file_body_wrapper";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { Record } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { Tag } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/tags/tag";
import { FileDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/file_details";
import { Choice } from "@zohocrm/typescript-sdk-2.0/utils/util/choice";
import { InventoryLineItems } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/inventory_line_items";
import { LineItemProduct } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_item_product";
import { LineTax } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/line_tax";
import { Reminder } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/reminder";
import { Participants } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/participants";
import { PricingDetails } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/pricing_details";
import { Comment } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/comment";
import { Layout } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/layouts/layout";
import { RemindAt } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/remind_at";
import { RecurringActivity } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/recurring_activity";
import { Consent } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/consent";
import { Info } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/info";
import { StreamWrapper } from "@zohocrm/typescript-sdk-2.0/utils/util/stream_wrapper";
import { BodyWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/body_wrapper";
import { ActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_handler";
import { ActionResponse } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/related_records/action_response";
export class RelatedRecord{
/**
* Delink Record
* This method is used to delete the association between modules and print the response
* @param moduleAPIName The API Name of the module to delink related record.
* @param recordId The ID of the record
* @param relatedListAPIName The API name of the related list.
* @param relatedListId The ID of the related record.
*/
public static async deLinkRecord(moduleAPIName: string, recordId: bigint, relatedListAPIName: string, relatedListId: bigint){
//example
// let moduleAPIName = "Products";
// let recordId = 3409643798007n;
// let relatedModuleAPIName = "Price_Books";
// let relatedListId = 34096432414001n;
//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
let relatedRecordsOperations: RelatedRecordsOperations = new RelatedRecordsOperations(relatedListAPIName, recordId, moduleAPIName);
//Call delinkRecord method that takes relatedListId as parameter.
let response: APIResponse<ActionHandler> = await relatedRecordsOperations.delinkRecord(relatedListId);
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 ActionResponse instances
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<string,any> = actionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
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<string,any> = 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<string,any> = 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());
}
}
}
}
}