TypeScript SDK Samples - Profile Operations

              Copy to Clipboard
              
import * as ZOHOCRMSDK  from "@zohocrm/typescript-sdk-2.1";

export class Profiles{

    /**
     * Get Profiles
     * This method is used to retrieve the profiles data through an API request and print the response.
     */
    public static async getProfiles() {

		//Get instance of ProfilesOperations Class that takes If-Modified-Since header as parameter.
		//To include If-Modified-Since header in the request, get the instance as follows
		let profilesOperations: ZOHOCRMSDK.Profiles.ProfilesOperations = new ZOHOCRMSDK.Profiles.ProfilesOperations();

		//To not include If-Modified-Since header to the request, get the instance as follows
		// let profilesOperations = new ProfilesOperations();

		//Call getProfiles method
		let response: ZOHOCRMSDK.APIResponse<ZOHOCRMSDK.Profiles.ResponseHandler.MasterModel> = await profilesOperations.getProfiles();

		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: ZOHOCRMSDK.Profiles.ResponseHandler.MasterModel = response.getObject();

			if (responseObject != null) {
				if (responseObject instanceof ZOHOCRMSDK.Profiles.ResponseWrapper) {
					let profiles: ZOHOCRMSDK.Profiles.Profile[] = responseObject.getProfiles();

					profiles.forEach(profile => {
						//Get the DisplayLabel of the each Profile
						console.log("Profile DisplayLabel: " + profile.getDisplayLabel());

						if (profile.getCreatedTime() != null) {
							//Get the CreatedTime of each Profile
							console.log("Profile CreatedTime: " + profile.getCreatedTime());
						}

						if (profile.getModifiedTime() != null) {
							//Get the ModifiedTime of each Profile
							console.log("Profile ModifiedTime: " + profile.getModifiedTime());
						}

						//Get the Name of the each Profile
						console.log("Profile Name: " + profile.getName());

						//Get the modifiedBy User instance of each Profile
						let modifiedBy: ZOHOCRMSDK.Users.User = profile.getModifiedBy();

						//Check if modifiedBy is not null
						if (modifiedBy != null) {
							//Get the ID of the modifiedBy User
							console.log("Profile Modified By User-ID: " + modifiedBy.getId());

							//Get the name of the modifiedBy User
							console.log("Profile Modified By User-Name: " + modifiedBy.getName());

							//Get the Email of the modifiedBy User
							console.log("Profile Modified By User-Email: " + modifiedBy.getEmail());
						}

						//Get the Description of the each Profile
						console.log("Profile Description: " + profile.getDescription());

						//Get the ID of the each Profile
						console.log("Profile ID: " + profile.getId());

						//Get the createdBy User instance of each Profile
						let createdBy: ZOHOCRMSDK.Users.User = profile.getCreatedBy();

						//Check if createdBy is not null
						if (createdBy != null) {
							//Get the ID of the createdBy User
							console.log("Profile Created By User-ID: " + createdBy.getId());

							//Get the name of the createdBy User
							console.log("Profile Created By User-Name: " + createdBy.getName());

							//Get the Email of the createdBy User
							console.log("Profile Created By User-Email: " + createdBy.getEmail());
						}
					});
				}
				//Check if the request returned an exception
				else if (responseObject instanceof ZOHOCRMSDK.Profiles.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());
				}
			}
		}
	}
}

              Copy to Clipboard
              
import * as ZOHOCRMSDK  from "@zohocrm/typescript-sdk-2.1";

export class Profiles{

    /**
     * Get a Profile
     * This method is used to get the details of any specific profile with ID.
     * @param profileId The ID of the Profile to be obtained
     */
    public static async getProfile(profileId: bigint) {
		//example
		// let profileId = 34096430026014n;

		//Get instance of ProfilesOperations Class
		let profilesOperations: ZOHOCRMSDK.Profiles.ProfilesOperations = new ZOHOCRMSDK.Profiles.ProfilesOperations();

		//Call getProfile method that takes profileId as parameter
		let response: ZOHOCRMSDK.APIResponse<ZOHOCRMSDK.Profiles.ResponseHandler.MasterModel> = await profilesOperations.getProfile(profileId);

		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 = response.getObject();

			if (responseObject != null) {
				//Check if expected ResponseWrapper instance is received
				if (responseObject instanceof ZOHOCRMSDK.Profiles.ResponseWrapper) {
					//Get the array of obtained Profile instances
					let profiles: ZOHOCRMSDK.Profiles.Profile[] = responseObject.getProfiles();

					profiles.forEach(profile => {
						//Get the DisplayLabel of the each Profile
						console.log("Profile DisplayLabel: " + profile.getDisplayLabel());

						if (profile.getCreatedTime() != null) {
							//Get the CreatedTime of each Profile
							console.log("Profile CreatedTime: " + profile.getCreatedTime());
						}

						if (profile.getModifiedTime() != null) {
							//Get the ModifiedTime of each Profile
							console.log("Profile ModifiedTime: " + profile.getModifiedTime());
						}

						//Get the permissionsDetails of each Profile
						let permissionsDetails: ZOHOCRMSDK.Profiles.PermissionDetail[] = profile.getPermissionsDetails();

						//Check if permissionsDetails is not null
						if (permissionsDetails != null) {

							permissionsDetails.forEach(permissionsDetail => {
								//Get the DisplayLabel of the each PermissionDetail
								console.log("Profile PermissionDetail DisplayLabel: " + permissionsDetail.getDisplayLabel());

								//Get the Module of the each PermissionDetail
								console.log("Profile PermissionDetail Module: " + permissionsDetail.getModule());

								//Get the Name of the each PermissionDetail
								console.log("Profile PermissionDetail Name: " + permissionsDetail.getName());

								//Get the ID of the each PermissionDetail
								console.log("Profile PermissionDetail ID: " + permissionsDetail.getId());

								//Get the Enabled of the each PermissionDetail
								console.log("Profile PermissionDetail Enabled: " + permissionsDetail.getEnabled());

							});
						}

						//Get the Name of the each Profile
						console.log("Profile Name: " + profile.getName());

						//Get the modifiedBy User instance of each Profile
						let modifiedBy: ZOHOCRMSDK.Users.User = profile.getModifiedBy();

						//Check if modifiedBy is not null
						if (modifiedBy != null) {
							//Get the ID of the modifiedBy User
							console.log("Profile Modified By User-ID: " + modifiedBy.getId());

							//Get the name of the modifiedBy User
							console.log("Profile Modified By User-Name: " + modifiedBy.getName());

							//Get the Email of the modifiedBy User
							console.log("Profile Modified By User-Email: " + modifiedBy.getEmail());
						}

						//Get the Description of the each Profile
						console.log("Profile Description: " + profile.getDescription());

						//Get the ID of the each Profile
						console.log("Profile ID: " + profile.getId());

						//Get the createdBy User instance of each Profile
						let createdBy: ZOHOCRMSDK.Users.User = profile.getCreatedBy();

						//Check if createdBy is not null
						if (createdBy != null) {
							//Get the ID of the createdBy User
							console.log("Profile Created By User-ID: " + createdBy.getId());

							//Get the name of the createdBy User
							console.log("Profile Created By User-Name: " + createdBy.getName());

							//Get the Email of the createdBy User
							console.log("Profile Created By User-Email: " + createdBy.getEmail());
						}

						//Get the sections of each Profile
						let sections: ZOHOCRMSDK.Profiles.Section[] = profile.getSections();

						//Check if sections is not null
						if (sections != null) {
							for (let section of sections) {
								//Get the Name of the each Section
								console.log("Profile Section Name: " + section.getName());

								//Get the categories of each Section
								let categories: ZOHOCRMSDK.Profiles.Category[] = section.getCategories();

								categories.forEach(category => {
									//Get the DisplayLabel of the each Category
									console.log("Profile Section Category DisplayLabel: " + category.getDisplayLabel());

									//Get the permissionsDetails List of each Category
									let categoryPermissionsDetails: string[] = category.getPermissionsDetails();

									//Check if categoryPermissionsDetails is not null
									if (categoryPermissionsDetails != null) {
										categoryPermissionsDetails.forEach(permissionsDetailID => {
											//Get the permissionsDetailID of the Category
											console.log("Profile Section Category permissionsDetailID: " + permissionsDetailID);
										});
									}

									//Get the Name of the each Category
									console.log("Profile Section Category Name: " + category.getName());
								});
							}
						}

						if (profile.getDelete() != null) {
							//Get the Delete of the each Profile
							console.log("Profile Delete: " + profile.getDelete().toString());
						}

						if (profile.getDefault() != null) {
							//Get the Default of the each Profile
							console.log("Profile Default: " + profile.getDefault().toString());
						}
					});
				}
				//Check if the request returned an exception
				else if (responseObject instanceof ZOHOCRMSDK.Profiles.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());
				}
			}
		}
	}
}