@zohocrm/typescript-sdk-8.0 1.0.0

package/dist/core/com/zoho/crm/api/webforms/web_form.js

@@ -0,0 +1,629 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebForm = exports.MasterModel = void 0;
+class WebForm {
+    constructor() {
+        this.keyModified = new Map();
+    }
+    /**
+     * The method to get the googleSite
+     * @returns A String representing the googleSite
+     */
+    getGoogleSite() {
+        return this.googleSite;
+    }
+    /**
+     * The method to set the value to googleSite
+     * @param googleSite A String representing the googleSite
+     */
+    setGoogleSite(googleSite) {
+        this.googleSite = googleSite;
+        this.keyModified.set("google_site", 1);
+    }
+    /**
+     * The method to get the encryptedFormId
+     * @returns A String representing the encryptedFormId
+     */
+    getEncryptedFormId() {
+        return this.encryptedFormId;
+    }
+    /**
+     * The method to set the value to encryptedFormId
+     * @param encryptedFormId A String representing the encryptedFormId
+     */
+    setEncryptedFormId(encryptedFormId) {
+        this.encryptedFormId = encryptedFormId;
+        this.keyModified.set("encrypted_form_id", 1);
+    }
+    /**
+     * The method to get the owner
+     * @returns An instance of Owner
+     */
+    getOwner() {
+        return this.owner;
+    }
+    /**
+     * The method to set the value to owner
+     * @param owner An instance of Owner
+     */
+    setOwner(owner) {
+        this.owner = owner;
+        this.keyModified.set("owner", 1);
+    }
+    /**
+     * The method to get the userType
+     * @returns An instance of User
+     */
+    getUserType() {
+        return this.userType;
+    }
+    /**
+     * The method to set the value to userType
+     * @param userType An instance of User
+     */
+    setUserType(userType) {
+        this.userType = userType;
+        this.keyModified.set("user_type", 1);
+    }
+    /**
+     * The method to get the acknowledgeVisitor
+     * @returns An instance of AcknowledgeVisitors
+     */
+    getAcknowledgeVisitor() {
+        return this.acknowledgeVisitor;
+    }
+    /**
+     * The method to set the value to acknowledgeVisitor
+     * @param acknowledgeVisitor An instance of AcknowledgeVisitors
+     */
+    setAcknowledgeVisitor(acknowledgeVisitor) {
+        this.acknowledgeVisitor = acknowledgeVisitor;
+        this.keyModified.set("acknowledge_visitor", 1);
+    }
+    /**
+     * The method to get the buttonAttributes
+     * @returns An Array representing the buttonAttributes
+     */
+    getButtonAttributes() {
+        return this.buttonAttributes;
+    }
+    /**
+     * The method to set the value to buttonAttributes
+     * @param buttonAttributes An Array representing the buttonAttributes
+     */
+    setButtonAttributes(buttonAttributes) {
+        this.buttonAttributes = buttonAttributes;
+        this.keyModified.set("button_attributes", 1);
+    }
+    /**
+     * The method to get the encryptedZgid
+     * @returns A String representing the encryptedZgid
+     */
+    getEncryptedZgid() {
+        return this.encryptedZgid;
+    }
+    /**
+     * The method to set the value to encryptedZgid
+     * @param encryptedZgid A String representing the encryptedZgid
+     */
+    setEncryptedZgid(encryptedZgid) {
+        this.encryptedZgid = encryptedZgid;
+        this.keyModified.set("encrypted_zgid", 1);
+    }
+    /**
+     * The method to get the createdTime
+     * @returns An instance of Date
+     */
+    getCreatedTime() {
+        return this.createdTime;
+    }
+    /**
+     * The method to set the value to createdTime
+     * @param createdTime An instance of Date
+     */
+    setCreatedTime(createdTime) {
+        this.createdTime = createdTime;
+        this.keyModified.set("created_time", 1);
+    }
+    /**
+     * The method to get the analyticsData
+     * @returns An instance of AnalyticsData
+     */
+    getAnalyticsData() {
+        return this.analyticsData;
+    }
+    /**
+     * The method to set the value to analyticsData
+     * @param analyticsData An instance of AnalyticsData
+     */
+    setAnalyticsData(analyticsData) {
+        this.analyticsData = analyticsData;
+        this.keyModified.set("analytics_data", 1);
+    }
+    /**
+     * The method to get the module
+     * @returns An instance of Module
+     */
+    getModule() {
+        return this.module;
+    }
+    /**
+     * The method to set the value to module
+     * @param module An instance of Module
+     */
+    setModule(module) {
+        this.module = module;
+        this.keyModified.set("module", 1);
+    }
+    /**
+     * The method to get the encryptedModule
+     * @returns A String representing the encryptedModule
+     */
+    getEncryptedModule() {
+        return this.encryptedModule;
+    }
+    /**
+     * The method to set the value to encryptedModule
+     * @param encryptedModule A String representing the encryptedModule
+     */
+    setEncryptedModule(encryptedModule) {
+        this.encryptedModule = encryptedModule;
+        this.keyModified.set("encrypted_module", 1);
+    }
+    /**
+     * The method to get the active
+     * @returns A Boolean representing the active
+     */
+    getActive() {
+        return this.active;
+    }
+    /**
+     * The method to set the value to active
+     * @param active A Boolean representing the active
+     */
+    setActive(active) {
+        this.active = active;
+        this.keyModified.set("active", 1);
+    }
+    /**
+     * The method to get the adwordEnabled
+     * @returns A Boolean representing the adwordEnabled
+     */
+    getAdwordEnabled() {
+        return this.adwordEnabled;
+    }
+    /**
+     * The method to set the value to adwordEnabled
+     * @param adwordEnabled A Boolean representing the adwordEnabled
+     */
+    setAdwordEnabled(adwordEnabled) {
+        this.adwordEnabled = adwordEnabled;
+        this.keyModified.set("adword_enabled", 1);
+    }
+    /**
+     * The method to get the notifyOwner
+     * @returns An instance of Owner
+     */
+    getNotifyOwner() {
+        return this.notifyOwner;
+    }
+    /**
+     * The method to set the value to notifyOwner
+     * @param notifyOwner An instance of Owner
+     */
+    setNotifyOwner(notifyOwner) {
+        this.notifyOwner = notifyOwner;
+        this.keyModified.set("notify_owner", 1);
+    }
+    /**
+     * The method to get the createdBy
+     * @returns An instance of User
+     */
+    getCreatedBy() {
+        return this.createdBy;
+    }
+    /**
+     * The method to set the value to createdBy
+     * @param createdBy An instance of User
+     */
+    setCreatedBy(createdBy) {
+        this.createdBy = createdBy;
+        this.keyModified.set("created_by", 1);
+    }
+    /**
+     * The method to get the formAttributes
+     * @returns An instance of FormAttributes
+     */
+    getFormAttributes() {
+        return this.formAttributes;
+    }
+    /**
+     * The method to set the value to formAttributes
+     * @param formAttributes An instance of FormAttributes
+     */
+    setFormAttributes(formAttributes) {
+        this.formAttributes = formAttributes;
+        this.keyModified.set("form_attributes", 1);
+    }
+    /**
+     * The method to get the locationUrl
+     * @returns An Array representing the locationUrl
+     */
+    getLocationUrl() {
+        return this.locationUrl;
+    }
+    /**
+     * The method to set the value to locationUrl
+     * @param locationUrl An Array representing the locationUrl
+     */
+    setLocationUrl(locationUrl) {
+        this.locationUrl = locationUrl;
+        this.keyModified.set("location_url", 1);
+    }
+    /**
+     * The method to get the landingUrl
+     * @returns A String representing the landingUrl
+     */
+    getLandingUrl() {
+        return this.landingUrl;
+    }
+    /**
+     * The method to set the value to landingUrl
+     * @param landingUrl A String representing the landingUrl
+     */
+    setLandingUrl(landingUrl) {
+        this.landingUrl = landingUrl;
+        this.keyModified.set("landing_url", 1);
+    }
+    /**
+     * The method to get the doubleOptinEnabled
+     * @returns A Boolean representing the doubleOptinEnabled
+     */
+    getDoubleOptinEnabled() {
+        return this.doubleOptinEnabled;
+    }
+    /**
+     * The method to set the value to doubleOptinEnabled
+     * @param doubleOptinEnabled A Boolean representing the doubleOptinEnabled
+     */
+    setDoubleOptinEnabled(doubleOptinEnabled) {
+        this.doubleOptinEnabled = doubleOptinEnabled;
+        this.keyModified.set("double_optin_enabled", 1);
+    }
+    /**
+     * The method to get the layout
+     * @returns An instance of Layout
+     */
+    getLayout() {
+        return this.layout;
+    }
+    /**
+     * The method to set the value to layout
+     * @param layout An instance of Layout
+     */
+    setLayout(layout) {
+        this.layout = layout;
+        this.keyModified.set("layout", 1);
+    }
+    /**
+     * The method to get the tags
+     * @returns An Array representing the tags
+     */
+    getTags() {
+        return this.tags;
+    }
+    /**
+     * The method to set the value to tags
+     * @param tags An Array representing the tags
+     */
+    setTags(tags) {
+        this.tags = tags;
+        this.keyModified.set("tags", 1);
+    }
+    /**
+     * The method to get the approvalRequest
+     * @returns A Boolean representing the approvalRequest
+     */
+    getApprovalRequest() {
+        return this.approvalRequest;
+    }
+    /**
+     * The method to set the value to approvalRequest
+     * @param approvalRequest A Boolean representing the approvalRequest
+     */
+    setApprovalRequest(approvalRequest) {
+        this.approvalRequest = approvalRequest;
+        this.keyModified.set("approval_request", 1);
+    }
+    /**
+     * The method to get the type
+     * @returns A String representing the type
+     */
+    getType() {
+        return this.type;
+    }
+    /**
+     * The method to set the value to type
+     * @param type A String representing the type
+     */
+    setType(type) {
+        this.type = type;
+        this.keyModified.set("type", 1);
+    }
+    /**
+     * The method to get the createContact
+     * @returns A Boolean representing the createContact
+     */
+    getCreateContact() {
+        return this.createContact;
+    }
+    /**
+     * The method to set the value to createContact
+     * @param createContact A Boolean representing the createContact
+     */
+    setCreateContact(createContact) {
+        this.createContact = createContact;
+        this.keyModified.set("create_contact", 1);
+    }
+    /**
+     * The method to get the assignmentRule
+     * @returns An instance of AssignmentRule
+     */
+    getAssignmentRule() {
+        return this.assignmentRule;
+    }
+    /**
+     * The method to set the value to assignmentRule
+     * @param assignmentRule An instance of AssignmentRule
+     */
+    setAssignmentRule(assignmentRule) {
+        this.assignmentRule = assignmentRule;
+        this.keyModified.set("assignment_rule", 1);
+    }
+    /**
+     * The method to get the name
+     * @returns A String representing the name
+     */
+    getName() {
+        return this.name;
+    }
+    /**
+     * The method to set the value to name
+     * @param name A String representing the name
+     */
+    setName(name) {
+        this.name = name;
+        this.keyModified.set("name", 1);
+    }
+    /**
+     * The method to get the id
+     * @returns A BigInt representing the id
+     */
+    getId() {
+        return this.id;
+    }
+    /**
+     * The method to set the value to id
+     * @param id A BigInt representing the id
+     */
+    setId(id) {
+        this.id = id;
+        this.keyModified.set("id", 1);
+    }
+    /**
+     * The method to get the spamControl
+     * @returns An instance of SpamControll
+     */
+    getSpamControl() {
+        return this.spamControl;
+    }
+    /**
+     * The method to set the value to spamControl
+     * @param spamControl An instance of SpamControll
+     */
+    setSpamControl(spamControl) {
+        this.spamControl = spamControl;
+        this.keyModified.set("spam_control", 1);
+    }
+    /**
+     * The method to get the fields
+     * @returns An Array representing the fields
+     */
+    getFields() {
+        return this.fields;
+    }
+    /**
+     * The method to set the value to fields
+     * @param fields An Array representing the fields
+     */
+    setFields(fields) {
+        this.fields = fields;
+        this.keyModified.set("fields", 1);
+    }
+    /**
+     * The method to get the formFields
+     * @returns An Array representing the formFields
+     */
+    getFormFields() {
+        return this.formFields;
+    }
+    /**
+     * The method to set the value to formFields
+     * @param formFields An Array representing the formFields
+     */
+    setFormFields(formFields) {
+        this.formFields = formFields;
+        this.keyModified.set("form_fields", 1);
+    }
+    /**
+     * The method to get the abtesting
+     * @returns An Array representing the abtesting
+     */
+    getAbtesting() {
+        return this.abtesting;
+    }
+    /**
+     * The method to set the value to abtesting
+     * @param abtesting An Array representing the abtesting
+     */
+    setAbtesting(abtesting) {
+        this.abtesting = abtesting;
+        this.keyModified.set("abtesting", 1);
+    }
+    /**
+     * The method to get the visitorTracking
+     * @returns A String representing the visitorTracking
+     */
+    getVisitorTracking() {
+        return this.visitorTracking;
+    }
+    /**
+     * The method to set the value to visitorTracking
+     * @param visitorTracking A String representing the visitorTracking
+     */
+    setVisitorTracking(visitorTracking) {
+        this.visitorTracking = visitorTracking;
+        this.keyModified.set("visitor_tracking", 1);
+    }
+    /**
+     * The method to get the lastSubmittedTime
+     * @returns An instance of Date
+     */
+    getLastSubmittedTime() {
+        return this.lastSubmittedTime;
+    }
+    /**
+     * The method to set the value to lastSubmittedTime
+     * @param lastSubmittedTime An instance of Date
+     */
+    setLastSubmittedTime(lastSubmittedTime) {
+        this.lastSubmittedTime = lastSubmittedTime;
+        this.keyModified.set("last_submitted_time", 1);
+    }
+    /**
+     * The method to get the actionOnSubmit
+     * @returns A String representing the actionOnSubmit
+     */
+    getActionOnSubmit() {
+        return this.actionOnSubmit;
+    }
+    /**
+     * The method to set the value to actionOnSubmit
+     * @param actionOnSubmit A String representing the actionOnSubmit
+     */
+    setActionOnSubmit(actionOnSubmit) {
+        this.actionOnSubmit = actionOnSubmit;
+        this.keyModified.set("action_on_submit", 1);
+    }
+    /**
+     * The method to get the actionValue
+     * @returns A String representing the actionValue
+     */
+    getActionValue() {
+        return this.actionValue;
+    }
+    /**
+     * The method to set the value to actionValue
+     * @param actionValue A String representing the actionValue
+     */
+    setActionValue(actionValue) {
+        this.actionValue = actionValue;
+        this.keyModified.set("action_value", 1);
+    }
+    /**
+     * The method to get the suggestion
+     * @returns An instance of Suggestion
+     */
+    getSuggestion() {
+        return this.suggestion;
+    }
+    /**
+     * The method to set the value to suggestion
+     * @param suggestion An instance of Suggestion
+     */
+    setSuggestion(suggestion) {
+        this.suggestion = suggestion;
+        this.keyModified.set("suggestion", 1);
+    }
+    /**
+     * The method to get the embedCode
+     * @returns A String representing the embedCode
+     */
+    getEmbedCode() {
+        return this.embedCode;
+    }
+    /**
+     * The method to set the value to embedCode
+     * @param embedCode A String representing the embedCode
+     */
+    setEmbedCode(embedCode) {
+        this.embedCode = embedCode;
+        this.keyModified.set("embed_code", 1);
+    }
+    /**
+     * The method to get the codeFormats
+     * @returns An Array representing the codeFormats
+     */
+    getCodeFormats() {
+        return this.codeFormats;
+    }
+    /**
+     * The method to set the value to codeFormats
+     * @param codeFormats An Array representing the codeFormats
+     */
+    setCodeFormats(codeFormats) {
+        this.codeFormats = codeFormats;
+        this.keyModified.set("code_formats", 1);
+    }
+    /**
+     * The method to get the sourceCode
+     * @returns A String representing the sourceCode
+     */
+    getSourceCode() {
+        return this.sourceCode;
+    }
+    /**
+     * The method to set the value to sourceCode
+     * @param sourceCode A String representing the sourceCode
+     */
+    setSourceCode(sourceCode) {
+        this.sourceCode = sourceCode;
+        this.keyModified.set("source_code", 1);
+    }
+    /**
+     * The method to get the iframeCode
+     * @returns A String representing the iframeCode
+     */
+    getIframeCode() {
+        return this.iframeCode;
+    }
+    /**
+     * The method to set the value to iframeCode
+     * @param iframeCode A String representing the iframeCode
+     */
+    setIframeCode(iframeCode) {
+        this.iframeCode = iframeCode;
+        this.keyModified.set("iframe_code", 1);
+    }
+    /**
+     * The method to check if the user has modified the given key
+     * @param key A String representing the key
+     * @returns A number representing the modification
+     */
+    isKeyModified(key) {
+        if (this.keyModified.has(key)) {
+            return this.keyModified.get(key);
+        }
+        return null;
+    }
+    /**
+     * The method to mark the given key as modified
+     * @param key A String representing the key
+     * @param modification A number representing the modification
+     */
+    setKeyModified(key, modification) {
+        this.keyModified.set(key, modification);
+    }
+}
+exports.MasterModel = WebForm;
+exports.WebForm = WebForm;

package/dist/core/com/zoho/crm/api/webforms/webforms_operations.d.ts

@@ -0,0 +1,76 @@
+import { ActionHandler } from "./action_handler";
+import { BodyWrapper } from "./body_wrapper";
+import { ResponseHandler } from "./response_handler";
+import { APIResponse } from "../../../../../../routes/controllers/api_response";
+declare class WebformsOperations {
+    private module?;
+    /**
+     * Creates an instance of WebformsOperations with the given parameters
+     * @param module A String representing the module
+     */
+    constructor(module?: string);
+    /**
+     * The method to get web forms
+     * @returns An instance of APIResponse<ResponseHandler>
+     * @throws SDKException
+     */
+    getWebForms(): Promise<APIResponse<ResponseHandler>>;
+    /**
+     * The method to create web forms
+     * @param request An instance of BodyWrapper
+     * @returns An instance of APIResponse<ActionHandler>
+     * @throws SDKException
+     */
+    createWebForms(request: BodyWrapper): Promise<APIResponse<ActionHandler>>;
+    /**
+     * The method to update web forms
+     * @param request An instance of BodyWrapper
+     * @returns An instance of APIResponse<ActionHandler>
+     * @throws SDKException
+     */
+    updateWebForms(request: BodyWrapper): Promise<APIResponse<ActionHandler>>;
+    /**
+     * The method to get web form
+     * @param formId A BigInt representing the formId
+     * @returns An instance of APIResponse<ResponseHandler>
+     * @throws SDKException
+     */
+    getWebForm(formId: bigint): Promise<APIResponse<ResponseHandler>>;
+    /**
+     * The method to update web form
+     * @param formId A BigInt representing the formId
+     * @param request An instance of BodyWrapper
+     * @returns An instance of APIResponse<ActionHandler>
+     * @throws SDKException
+     */
+    updateWebForm(formId: bigint, request: BodyWrapper): Promise<APIResponse<ActionHandler>>;
+    /**
+     * The method to delete web forms
+     * @param formId A BigInt representing the formId
+     * @returns An instance of APIResponse<ActionHandler>
+     * @throws SDKException
+     */
+    deleteWebForms(formId: bigint): Promise<APIResponse<ActionHandler>>;
+    /**
+     * The method to get webforms preview
+     * @param formId A BigInt representing the formId
+     * @returns An instance of APIResponse<ResponseHandler>
+     * @throws SDKException
+     */
+    getWebformsPreview(formId: bigint): Promise<APIResponse<ResponseHandler>>;
+}
+declare class GetWebFormsParam {
+}
+declare class CreateWebFormsParam {
+}
+declare class UpdateWebFormsParam {
+}
+declare class GetWebFormParam {
+}
+declare class UpdateWebFormParam {
+}
+declare class DeleteWebFormsParam {
+}
+declare class GetWebformsPreviewParam {
+}
+export { GetWebFormsParam as GetWebFormsParam, UpdateWebFormsParam as UpdateWebFormsParam, UpdateWebFormParam as UpdateWebFormParam, WebformsOperations as MasterModel, WebformsOperations as WebformsOperations, CreateWebFormsParam as CreateWebFormsParam, DeleteWebFormsParam as DeleteWebFormsParam, GetWebFormParam as GetWebFormParam, GetWebformsPreviewParam as GetWebformsPreviewParam };