TypeScript SDK Samples - Shared Records Operations
import {ShareRecordsOperations,GetSharedRecordDetailsParam} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/share_records_operations";
import {ActionHandler} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_handler";
import {ActionResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_response";
import {SuccessResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/success_response";
import {ActionWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_wrapper";
import {DeleteActionWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_wrapper";
import {DeleteActionResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_response";
import {APIException} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/api_exception";
import {BodyWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/body_wrapper";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/response_handler";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/response_wrapper";
import { ShareRecord } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/share_record";
import { SharedThrough } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/shared_through";
import { Module } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/module";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { DeleteActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_handler";
export class ShareRecords{
/**
* Get Shared Record Details
* This method is used to get the details of a shared record and print the response.
* @param moduleAPIName The API Name of the module to get shared record details.
* @param recordId The ID of the record to be obtain shared information
*/
public static async getSharedRecordDetails(moduleAPIName: string, recordId: bigint){
//example
//let moduleAPIName = "Contacts";
//let recordId = 34096432112011n;
//Get instance of ShareRecordsOperations Class that takes moduleAPIName and recordId as parameter
let sharedRecordsOperations: ShareRecordsOperations = new ShareRecordsOperations(recordId, moduleAPIName);
//Get instance of ParameterMap Class
let paramInstance: ParameterMap = new ParameterMap();
/* Possible parameters of Get Shared Record Details operation */
await paramInstance.add(GetSharedRecordDetailsParam.VIEW, "summary");
// await paramInstance.add(GetSharedRecordDetailsParam.SHAREDTO, "3409643302031");
//Call getSharedRecordDetails method that takes ParameterMap instance as parameter
let response: APIResponse<ResponseHandler> = await sharedRecordsOperations.getSharedRecordDetails(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 ResponseWrapper instance is received
if(responseObject instanceof ResponseWrapper){
//Get the array of obtained ShareRecord instances
let shareRecords: ShareRecord[] = responseObject.getShare();
shareRecords.forEach(shareRecord => {
//Get the ShareRelatedRecords of each ShareRecord
console.log("ShareRecord ShareRelatedRecords: " + shareRecord.getShareRelatedRecords().toString());
//Get the SharedThrough instance of each ShareRecord
let sharedThrough: SharedThrough = shareRecord.getSharedThrough();
//Check if sharedThrough is not null
if(sharedThrough != null){
//Get the EntityName of the SharedThrough
console.log("ShareRecord SharedThrough EntityName: " + sharedThrough.getEntityName());
let module: Module = sharedThrough.getModule();
if(module != null){
//Get the ID of the Module
console.log("ShareRecord SharedThrough Module ID: " + module.getId().toString());
//Get the name of the Module
console.log("ShareRecord SharedThrough Module Name: " + module.getName());
}
//Get the ID of the SharedThrough
console.log("ShareRecord SharedThrough ID: " + sharedThrough.getId());
}
//Get the SharedTime of each ShareRecord
console.log("ShareRecord SharedTime: " + shareRecord.getSharedTime().toString());
//Get the Permission of each ShareRecord
console.log("ShareRecord Permission: " + shareRecord.getPermission().toString());
//Get the sharedBy of each ShareRecord
let sharedBy: User = shareRecord.getSharedBy();
if(sharedBy != null) {
//Get the ID of the User
console.log("ShareRecord SharedBy-ID: " + sharedBy.getId());
//Get the FullName of the User
console.log("ShareRecord SharedBy-FullName: " + sharedBy.getFullName());
//Get the Zuid of the User
console.log("ShareRecord SharedBy-Zuid: " + sharedBy.getZuid());
}
//Get the shared User instance of each ShareRecord
let user: User = shareRecord.getUser();
//Check if user is not null
if(user != null){
//Get the ID of the shared User
console.log("ShareRecord User-ID: " + user.getId());
//Get the FullName of the shared User
console.log("ShareRecord User-FullName: " + user.getFullName());
//Get the Zuid of the shared User
console.log("ShareRecord User-Zuid: " + user.getZuid());
}
});
let shareableUsers: User[] = responseObject.getShareableUser();
if(shareableUsers != null && shareableUsers != undefined){
shareableUsers.forEach(shareableUser => {
//Get the ID of the shareable User
console.log("Shareable User User-ID: " + shareableUser.getId());
//Get the FullName of the shareable User
console.log("Shareable User User-FullName: " + shareableUser.getFullName());
//Get the Zuid of the shareable User
console.log("Shareable User User-Zuid: " + shareableUser.getZuid());
});
}
}
//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());
}
}
}
}
}
import {ShareRecordsOperations,GetSharedRecordDetailsParam} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/share_records_operations";
import {ActionHandler} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_handler";
import {ActionResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_response";
import {SuccessResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/success_response";
import {ActionWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_wrapper";
import {DeleteActionWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_wrapper";
import {DeleteActionResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_response";
import {APIException} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/api_exception";
import {BodyWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/body_wrapper";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/response_handler";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/response_wrapper";
import { ShareRecord } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/share_record";
import { SharedThrough } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/shared_through";
import { Module } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/module";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { DeleteActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_handler";
export class ShareRecords{
/**
* Share Record
* This method is used to share the record and print the response.
* @param moduleAPIName The API Name of the module to share record.
* @param recordId The ID of the record to be shared
*/
public static async shareRecord(moduleAPIName: string, recordId: bigint){
//example
//let moduleAPIName = "Contacts";
// let recordId = 34096432112011n;
//Get instance of ShareRecordsOperations Class that takes moduleAPIName and recordId as parameter
let sharedRecordsOperations: ShareRecordsOperations = new ShareRecordsOperations(recordId, moduleAPIName);
//Get instance of BodyWrapper Class that will contain the request body
let request: BodyWrapper = new BodyWrapper();
//Array to hold ShareRecord instances
let shareRecordArray: ShareRecord[] = [];
//Get instance of ShareRecord Class
let shareRecord: ShareRecord = new ShareRecord();
//Set boolean value to share related records
shareRecord.setShareRelatedRecords(false);
//Set the permission. Possible values - full_access, read_only, read_write
shareRecord.setPermission("read_write");
//Get instance of User Class
let user: User = new User();
//Set User ID
user.setId(BigInt("34770615791024"));
//Set the User instance to user
shareRecord.setUser(user);
//Add the instance to array
shareRecordArray.push(shareRecord);
//Set the array to share of BodyWrapper instance
request.setShare(shareRecordArray);
//Call shareRecord method that takes BodyWrapper instance as parameter
let response: APIResponse<ActionHandler> = await sharedRecordsOperations.shareRecord(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.getShare();
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());
}
}
}
}
}
Update Share Permissions
import {ShareRecordsOperations,GetSharedRecordDetailsParam} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/share_records_operations";
import {ActionHandler} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_handler";
import {ActionResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_response";
import {SuccessResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/success_response";
import {ActionWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_wrapper";
import {DeleteActionWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_wrapper";
import {DeleteActionResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_response";
import {APIException} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/api_exception";
import {BodyWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/body_wrapper";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/response_handler";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/response_wrapper";
import { ShareRecord } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/share_record";
import { SharedThrough } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/shared_through";
import { Module } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/module";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { DeleteActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_handler";
export class ShareRecords{
/**
* Update Share Permissions
* This method is used to update the sharing permissions of a record granted to users as Read-Write, Read-only, or grant full access.
* @param moduleAPIName The API Name of the module to update share permissions.
* @param recordId The ID of the record
*/
public static async updateSharePermissions(moduleAPIName: string, recordId: bigint){
//example
//let moduleAPIName = "Contacts";
// let recordId = 34096432112011n;
//Get instance of ShareRecordsOperations Class that takes moduleAPIName and recordId as parameter
let sharedRecordsOperations: ShareRecordsOperations = new ShareRecordsOperations(recordId, moduleAPIName);
//Get instance of BodyWrapper Class that will contain the request body
let request: BodyWrapper = new BodyWrapper();
//Array to hold ShareRecord instances
let shareRecordArray: ShareRecord[] = [];
//Get instance of ShareRecord
let shareRecord: ShareRecord = new ShareRecord();
//Set the permission
shareRecord.setPermission("full_access");
//Set the boolean value to share related records
shareRecord.setShareRelatedRecords(true);
//Get instance of User Class
let user: User = new User();
//Set ID to the User
user.setId(BigInt("34770615791024"));
//Set user instance to user in ShareRecord instance
shareRecord.setUser(user);
//Add the instance to array
shareRecordArray.push(shareRecord);
//Set the array to share in BodyWrapper
request.setShare(shareRecordArray);
//Call updateSharePermissions method that takes BodyWrapper instance as parameter
let response: APIResponse<ActionHandler> = await sharedRecordsOperations.updateSharePermissions(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.getShare();
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());
}
}
}
}
}
Revoke Access to a Shared Record
import {ShareRecordsOperations,GetSharedRecordDetailsParam} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/share_records_operations";
import {ActionHandler} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_handler";
import {ActionResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_response";
import {SuccessResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/success_response";
import {ActionWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/action_wrapper";
import {DeleteActionWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_wrapper";
import {DeleteActionResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_response";
import {APIException} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/api_exception";
import {BodyWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/body_wrapper";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/response_handler";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/response_wrapper";
import { ShareRecord } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/share_record";
import { SharedThrough } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/shared_through";
import { Module } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/modules/module";
import { User } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/users/user";
import { DeleteActionHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/share_records/delete_action_handler";
export class ShareRecords{
/**
* Revoke Shared Record
* This method is used to revoke access to a shared record that was shared to users and print the response.
* @param moduleAPIName The API Name of the module to revoke shared record.
* @param recordId The ID of the record
*/
public static async revokeSharedRecord(moduleAPIName: string, recordId: bigint){
//example
//let moduleAPIName = "Contacts";
// let recordId = 34096432112011n;
//Get instance of ShareRecordsOperations Class that takes moduleAPIName and recordId as parameter
let shareRecordsOperations: ShareRecordsOperations = new ShareRecordsOperations(recordId, moduleAPIName);
//Call revokeSharedRecord method
let response: APIResponse<DeleteActionHandler> = await shareRecordsOperations.revokeSharedRecord();
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
//Get object from response
let responseObject = response.getObject();
if(responseObject != null){
//Check if expected ActionWrapper instance is received
if(responseObject instanceof DeleteActionWrapper){
let deleteActionResponse: DeleteActionResponse = responseObject.getShare();
if(deleteActionResponse instanceof SuccessResponse){
console.log("Status: " + deleteActionResponse.getStatus().getValue());
console.log("Code: " + deleteActionResponse.getCode().getValue());
console.log("Details");
let details: Map<string,any> = deleteActionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
console.log("Message: " + deleteActionResponse.getMessage().getValue());
}
else if(deleteActionResponse instanceof APIException){
console.log("Status: " + deleteActionResponse.getStatus().getValue());
console.log("Code: " + deleteActionResponse.getCode().getValue());
console.log("Details");
let details: Map<string,any> = deleteActionResponse.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
console.log("Message: " + deleteActionResponse.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());
}
}
}
}
}