Your use case. Our milestone. The 200th post in our "Kaizen Series: Continuous Improvement for Developer Experience" is coming up. Share Now

X
Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Easy domain registration, transfer, and secured DNS management.

Try now
New

Payroll software with automated tax payments and filing.

Try now
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Unified payment solution built for all businesses.

Try now
New

Comprehensive email security and archiving for every business.

Try now
Suites

Cloud-based qualitative data analysis tool.

Try now
New

Online community platform for individuals and businesses to grow their network and brand.

Try now
New

Modern retail POS to sell better, manage your entire business, and join the digital revolution.

Try now
SuitesNew

Unified project management platform for intelligent, data-driven work.

Try now
Suites

Unified platform for customer service and support teams.

Try now

Sales

CRM

Comprehensive CRM platform for customer-facing teams.

CRM
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
Thrive

Complete loyalty and affiliate management platform.

Thrive
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Social

All-in-one social media management software.

Social
Survey

Design surveys to reach and interact with your audience.

Survey
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Sites

Online website builder with extensive customisation options.

Sites
Backstage

End-to-end event management software.

Backstage
PageSense

Website conversion optimization and personalisation platform.

PageSense
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
Webinar

Webinar platform for webcasting online webinars.

Webinar
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
NEW
Domains

Easy domain registration, transfer, and secured DNS management.

Domains
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
Thrive

Complete loyalty and affiliate management platform.

Thrive
Publish

Manage all your local business listings on a single platform.

Publish
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

Desk

Helpdesk software to deliver great customer support.

Desk
Assist

Remote support and unattended remote access software.

Assist
Voice

Cloud Contact Center Software for businesses.

Voice
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
FSM

End-to-end field service management platform for service businesses.

FSM
Lens

Interactive remote assistance software with augmented reality.

Lens
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

Books

Powerful accounting platform for growing businesses.

Books
Expense

Effortless expense reporting platform.

Expense
Sign

Digital signature app for businesses.

Sign
Inventory

Powerful stock management and inventory control software.

Inventory
FREE
Invoice

100% Free invoicing solution.

Invoice
Billing

End-to-end billing solution for your business.

Billing
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Commerce

eCommerce platform to manage and market your online store.

Commerce
Checkout

Collect payments online with custom branded pages.

Checkout
Practice

Practice management software for accounting firms.

Practice
Solo

The all-in-one toolkit for solopreneurs.

Solo
NEW
Payments

Unified payment solution built for all businesses.

Payments
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email, Storage, and Collaboration

Mail

Secure email service for teams of all sizes.

Mail
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
WorkDrive

Online file management for teams.

WorkDrive
Bookings

Appointment scheduling app for consultations with customers.

Bookings
Cliq

Stay in touch with teams no matter where you are.

Cliq
Notebook

Beautiful home for all your notes.

Notebook
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
Learn

Knowledge and learning management platform.

Learn
Office Integrator

Built in document editors for web apps.

Office Integrator
Writer

Word processor for focused writing and discussions.

Writer
TeamInbox

Shared inboxes for teams.

TeamInbox
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Show

Create, edit, and share slides with a sleek presentation app.

Show
Tables

Work management tool to connect people, processes, and information.

Tables
Sheet

Spreadsheet software for collaborative teams.

Sheet
Office Suite

Powerful collaborative work platform for teams.

Office Suite
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
ToDo

Collaborative task management for individuals and teams.

ToDo
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

Expense

Effortless expense reporting platform.

Expense
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
People

Organize, automate, and simplify your HR processes.

People
Sign

Digital signature app for businesses.

Sign
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Shifts

Employee scheduling and time tracking app.

Shifts
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

Creator

Build custom apps to simplify business processes.

Creator
Assist

Remote support and unattended remote access software.

Assist
Vault

Online password manager for teams.

Vault
Directory

Workforce identity and access management solution for cloud businesses.

Directory
Lens

Interactive remote assistance software with augmented reality.

Lens
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
eProtect

Comprehensive email security and archiving for every business.

eProtect
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit

BI and Analytics

Analytics

Modern self-service BI and analytics platform.

Analytics
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

Project Management

Projects

Manage, track, and collaborate on projects with teams.

Projects
Sprints

Planning and tracking tool for scrum teams.

Sprints
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Projects Plus

Unified project management platform for intelligent, data-driven work.

Projects Plus

Developer Platforms

Creator

Build custom apps to simplify business processes.

Creator
Flow

Automate business workflows by creating smart integrations.

Flow
Office Integrator

Built in document editors for web apps.

Office Integrator
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Tables

Work management tool to connect people, processes, and information.

Tables
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
Apptics

Application analytics for all apps.

Apptics
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

IoT

NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
Projects Plus

Unified project management platform for intelligent, data-driven work.

Try now
Projects Plus
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Skip to main content

Ruby SDK Samples - Variable Operations

Get Variables
              
              
require 'ZOHOCRMSDK2_0'
class Variable
    def self.get_variables
    # """
    # This method is used to retrieve all the available variables through an API request and print the response.
    # """
    # Get instance of VariablesOperations Class
    vo = Variables::VariablesOperations.new
    # Get instance of ParameterMap Class
    pm = ParameterMap.new
    # Possible parameters of Get Variables operation
    pm.add(Variables::VariablesOperations::GetVariablesParam.group, 'created')
    # Call get_variables method that takes ParameterMap instance as parameter
    response = vo.get_variables(pm)
    unless response.nil?
      status_code = response.status_code
      # Get the status code from response
      print "\n Status Code :" + status_code.to_s
      if [204, 304].include? status_code
        print(status_code == 204 ? 'No Content' : 'Not Modified')
        return
      end
      # Check if expected instance is received.
      if response.is_expected
        # Get object from response
        response_handler = response.data_object
        # Check if expected ResponseWrapper instance is received
        if response_handler.is_a? Variables::ResponseWrapper
          # Get the list of obtained Variable instances
          variables = response_handler.variables
          variables.each do |variable|
            # Get the APIName of each Variable
            print "\n Variable APIName: "
            print variable.api_name
            # Get the Name of each Variable
            print "\n Variable Name: "
            print variable.name
            # Get the Description of each Variable
            print "\n Variable Description: "
            print variable.description
            # Get the ID of each Variable
            print "\n Variable ID: "
            print variable.id.to_s
            # Get the Type of each Variable
            print "\n Variable Type: "
            print variable.type
            # Get the VariableGroup instance of each Variable
            variable_group = variable.variable_group
            unless variable_group.nil?
              # Get the APIName of the VariableGroup
              print "\n Variable VariableGroup APIName: "
              print variable_group.api_name
              # Get the ID of the VariableGroup
              print "\n Variable VariableGroup ID: "
              print variable_group.id.to_s
            end
            # Get the Value of each Variable
            print "\n Variable Value: "
            print variable.value
          end
        # Check if the request returned an exception
        elsif response_handler.is_a? Variables::APIException
          exception = response_handler
          # Get the Code
          print 'code:'
          print exception.code.value
          # Get the Status
          print "\n status:"
          print exception.status.value
          # Get the Message
          print "\n message:"
          print exception.message.value
          # Get the Details map
          exception.details.each do |k, v|
            print "\n"
            print k
            print v
            print "\n"
          end
          print "\n"
        end
      else
        response_object = response.data_object
        response_object.instance_variables.each do |field|
          print field
          print "\n"
          print response_object.instance_variable_get(field)
        end
      end
    end
  end
end
 
Create Variables
              
              
require 'ZOHOCRMSDK2_0'
class Variable
    def self.create_variables
    # """
    # This method is used to create variables and print the response.
    # """
    # Get instance of VariablesOperations Class
    vo = Variables::VariablesOperations.new
    # Get instance of BodyWrapper Class that will contain the request body
    bw = Variables::BodyWrapper.new
    # List to hold Variable instances
    variables = []
    # Get instance of VariableGroup Class
    group = VariableGroups::VariableGroup.new
    # Set Name to variable_group
    group.name = 'created'
    for i in 10..14
      # Get instance of Variable Class
      variable = Variables::Variable.new
      # Set the type to Variable
      variable.type = 'integer'
      # Set the value
      variable.value = 1
      # Set the name to variable
      variable.name = i.to_s
      # Set the API name to variable
      variable.api_name = i.to_s
      # Set the VariableGroup to Variable instance
      variable.variable_group = group
      # Set the description to variable
      variable.description = i.to_s
      # Add the variable instance to the array
      variables.push(variable)
    end
    # Set the list to variables in BodyWrapper instance
    bw.variables = variables
    # Call create_variables method that takes BodyWrapper instance as parameter
    response = vo.create_variables(bw)
    unless response.nil?
      # Get the status code from response
      status_code = response.status_code
      print "\n Status Code :" + status_code.to_s
      # Check if expected instance is received.
      if response.is_expected
        # Get object from response
        action_handler = response.data_object
        # Check if expected ActionWrapper instance is received.
        if action_handler.is_a? Variables::ActionWrapper
          action_wrapper = action_handler
          # Get the list of obtained ActionResponse instances
          action_responses = action_wrapper.variables
          action_responses.each do |action_response|
            # Check if expected SuccessResponse instance is received.
            if action_response.is_a? Variables::SuccessResponse
              success_response = action_response
              # Get the Code
              print 'code:'
              print success_response.code.value
              # Get the Status
              print "\n status:"
              print success_response.status.value
              # Get the Message
              print "\n message:"
              print success_response.message.value
              success_response.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
            # Check if the request returned an exception
            elsif action_response.is_a? Variables::APIException
              api_exception = action_response
              # Get the Code
              print 'code:'
              print api_exception.code.value
              # Get the Status
              print "\n status:"
              print api_exception.status.value
              # Get the Message
              print "\n message:"
              print api_exception.message.value
              # Get the details map
              api_exception.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
              print "\n"
            end
          end
        # Check if the request returned an exception
        elsif action_handler.is_a? Variables::APIException
          exception = action_handler
          # Get the Code
          print 'code:'
          print exception.code.value
          # Get the Status
          print "\n status:"
          print exception.status.value
          # Get the Message
          print "\n message:"
          print exception.message.value
          # Get the details map
          exception.details.each do |k, v|
            print "\n"
            print k
            print v
            print "\n"
          end
          print "\n"
        end
      else
        response_object = response.data_object
        response_object.instance_variables.each do |field|
          print field
          print "\n"
          print response_object.instance_variable_get(field)
        end
      end
    end
  end
end
 
Update Variables
Delete Variables
              
              
require 'ZOHOCRMSDK2_0'
class Variable
    def self.delete_variables(variable_ids)
    # """
    # This method is used to delete details of multiple variables in CRM simultaneously and print the response.
    # :param variable_ids: The list of Variable IDs to be deleted
    # """

    # """
    # example
    # variable_ids = ["3409643000002275025", "3409643000002275035"]
    # """
    # Get instance of ParameterMap Class
    pm = ParameterMap.new
    variable_ids.each do |variable_id|
      # Possible parameters of Delete Variables operation
      pm.add(Variables::VariablesOperations::DeleteVariablesParam.ids, variable_id)
    end
    # Get instance of VariablesOperations Class
    vo = Variables::VariablesOperations.new
    # Call delete_variables method that takes ParameterMap instance as parameter
    response = vo.delete_variables(pm)
    unless response.nil?
      # Get the status code from response
      status_code = response.status_code
      print "\n Status Code :" + status_code.to_s
      # Check if expected instance is received.
      if response.is_expected
        # Get object from response
        action_handler = response.data_object
        # Check if expected ActionWrapper instance is received.
        if action_handler.is_a? Variables::ActionWrapper
          action_wrapper = action_handler
          # Get the list of obtained ActionResponse instances
          action_responses = action_wrapper.variables
          action_responses.each do |action_response|
            # Check if expected SuccessResponse instance is received.
            if action_response.is_a? Variables::SuccessResponse
              success_response = action_response
              # Get the Code
              print 'code:'
              print success_response.code.value
              # Get the Status
              print "\n status:"
              print success_response.status.value
              # Get the Message
              print "\n message:"
              print success_response.message.value
              success_response.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
            # Check if the request returned an exception
            elsif action_response.is_a? Variables::APIException
              api_exception = action_response
              # Get the Code
              print 'code:'
              print api_exception.code.value
              # Get the Status
              print "\n status:"
              print api_exception.status.value
              # Get the Message
              print "\n message:"
              print api_exception.message.value
              # Get the details map
              api_exception.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
              print "\n"
            end
          end
        # Check if the request returned an exception
        elsif action_handler.is_a? Variables::APIException
          exception = action_handler
          # Get the Code
          print 'code:'
          print exception.code.value
          # Get the Status
          print "\n status:"
          print exception.status.value
          # Get the Message
          print "\n message:"
          print exception.message.value
          # Get the details map
          exception.details.each do |k, v|
            print "\n"
            print k
            print v
            print "\n"
          end
          print "\n"
        end
      else
        response_object = response.data_object
        response_object.instance_variables.each do |field|
          print field
          print "\n"
          print response_object.instance_variable_get(field)
        end
      end
    end
  end
end
 
Get a Variable by its ID
              
              
require 'ZOHOCRMSDK2_0'
class Variable
    def self.get_variable_by_id(variable_id)
    # """
    # This method is used to get the details of any specific variable with ID and print the response
    # :param variable_id: The ID of the Variable to be obtained
    # """

    # """
    # example
    # variable_id = 3409643000002275025
    # """
    # Get instance of VariablesOperations Class
    vo = Variables::VariablesOperations.new
    # Get instance of pm Class
    pm = ParameterMap.new
    # Possible parameters of Get Variable By ID operation
    pm.add(Variables::VariablesOperations::GetVariableByIDParam.group, 'created')
    # Call get_variable_by_id method that takes ParameterMap instance and variable_id as parameters
    response = vo.get_variable_by_id(variable_id, pm)
    unless response.nil?
      status_code = response.status_code
      # Get the status code from response
      print "\n Status Code :" + status_code.to_s
      if [204, 304].include? status_code
        print(status_code == 204 ? 'No Content' : 'Not Modified')
        return
      end
      # Check if expected instance is received.
      if response.is_expected
        # Get object from response
        response_handler = response.data_object
        # Check if expected ResponseWrapper instance is received
        if response_handler.is_a? Variables::ResponseWrapper
          # Get the list of obtained Variable instances
          variables = response_handler.variables
          variables.each do |variable|
            # Get the APIName of each Variable
            print "\n Variable APIName: "
            print variable.api_name
            # Get the Name of each Variable
            print "\n Variable Name: "
            print variable.name
            # Get the Description of each Variable
            print "\n Variable Description: "
            print variable.description
            # Get the ID of each Variable
            print "\n Variable ID: "
            print variable.id.to_s
            # Get the Type of each Variable
            print "\n Variable Type: "
            print variable.type
            # Get the VariableGroup instance of each Variable
            variable_group = variable.variable_group
            unless variable_group.nil?
              # Get the APIName of the VariableGroup
              print "\n Variable VariableGroup APIName: "
              print variable_group.api_name
              # Get the ID of the VariableGroup
              print "\n Variable VariableGroup ID: "
              print variable_group.id.to_s
            end
            # Get the Value of each Variable
            print "\n Variable Value: "
            print variable.value
          end
        # Check if the request returned an exception
        elsif response_handler.is_a? Variables::APIException
          exception = response_handler
          # Get the Code
          print 'code:'
          print exception.code.value
          # Get the Status
          print "\n status:"
          print exception.status.value
          # Get the Message
          print "\n message:"
          print exception.message.value
          # Get the Details map
          exception.details.each do |k, v|
            print "\n"
            print k
            print v
            print "\n"
          end
          print "\n"
        end
      else
        response_object = response.data_object
        response_object.instance_variables.each do |field|
          print field
          print "\n"
          print response_object.instance_variable_get(field)
        end
      end
    end
  end
end
 
Update a Variable by its ID
              
              
require 'ZOHOCRMSDK2_0'
class Variable
    def self.update_variable_by_id(variable_id)
    # """
    # This method is used to update details of a specific variable in CRM and print the response.
    # :param variable_id: The ID of the Variable to be updated
    # :return:
    # """

    # """
    # example
    # variable_id = 3409643000002275025
    # """
    # Get instance of VariablesOperations Class
    vo = Variables::VariablesOperations.new
    # Get instance of BodyWrapper Class that will contain the request body
    bw = Variables::BodyWrapper.new
    # List to hold Variable instances
    variables = []
    # Get instance of Variable Class
    variable = Variables::Variable.new
    # Set the value
    variable.value = 3434
    # Add the variable instance to the array
    variables.push(variable)
    # Set the list to variables in BodyWrapper instance
    bw.variables = variables
    # Call update_variable_by_id method that takes BodyWrapper instance and variable_id as parameters
    response = vo.update_variable_by_id(variable_id,bw)
    unless response.nil?
      # Get the status code from response
      status_code = response.status_code
      print "\n Status Code :" + status_code.to_s
      # Check if expected instance is received.
      if response.is_expected
        # Get object from response
        action_handler = response.data_object
        # Check if expected ActionWrapper instance is received.
        if action_handler.is_a? Variables::ActionWrapper
          action_wrapper = action_handler
          # Get the list of obtained ActionResponse instances
          action_responses = action_wrapper.variables
          action_responses.each do |action_response|
            # Check if expected SuccessResponse instance is received.
            if action_response.is_a? Variables::SuccessResponse
              success_response = action_response
              # Get the Code
              print 'code:'
              print success_response.code.value
              # Get the Status
              print "\n status:"
              print success_response.status.value
              # Get the Message
              print "\n message:"
              print success_response.message.value
              success_response.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
            # Check if the request returned an exception
            elsif action_response.is_a? Variables::APIException
              api_exception = action_response
              # Get the Code
              print 'code:'
              print api_exception.code.value
              # Get the Status
              print "\n status:"
              print api_exception.status.value
              # Get the Message
              print "\n message:"
              print api_exception.message.value
              # Get the details map
              api_exception.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
              print "\n"
            end
          end
        # Check if the request returned an exception
        elsif action_handler.is_a? Variables::APIException
          exception = action_handler
          # Get the Code
          print 'code:'
          print exception.code.value
          # Get the Status
          print "\n status:"
          print exception.status.value
          # Get the Message
          print "\n message:"
          print exception.message.value
          # Get the details map
          exception.details.each do |k, v|
            print "\n"
            print k
            print v
            print "\n"
          end
          print "\n"
        end
      else
        response_object = response.data_object
        response_object.instance_variables.each do |field|
          print field
          print "\n"
          print response_object.instance_variable_get(field)
        end
      end
    end
  end
end
 
Delete a Variable
              
              
require 'ZOHOCRMSDK2_0'
class Variable
    def self.delete_variable(variable_id)
    # """
    # This method is used to delete details of a specific variable in CRM and print the response.
    # :param variable_id: The ID of the Variable to be deleted
    # """

    # """
    # example
    # variable_id = 3409643000002275025
    # """
    # Get instance of VariablesOperations Class
    vo = Variables::VariablesOperations.new
    # Call delete_variable method that takes variable_id as parameter
    response = vo.delete_variable(variable_id)
    unless response.nil?
      # Get the status code from response
      status_code = response.status_code
      print "\n Status Code :" + status_code.to_s
      # Check if expected instance is received.
      if response.is_expected
        # Get object from response
        action_handler = response.data_object
        # Check if expected ActionWrapper instance is received.
        if action_handler.is_a? Variables::ActionWrapper
          action_wrapper = action_handler
          # Get the list of obtained ActionResponse instances
          action_responses = action_wrapper.variables
          action_responses.each do |action_response|
            # Check if expected SuccessResponse instance is received.
            if action_response.is_a? Variables::SuccessResponse
              success_response = action_response
              # Get the Code
              print 'code:'
              print success_response.code.value
              # Get the Status
              print "\n status:"
              print success_response.status.value
              # Get the Message
              print "\n message:"
              print success_response.message.value
              success_response.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
            # Check if the request returned an exception
            elsif action_response.is_a? Variables::APIException
              api_exception = action_response
              # Get the Code
              print 'code:'
              print api_exception.code.value
              # Get the Status
              print "\n status:"
              print api_exception.status.value
              # Get the Message
              print "\n message:"
              print api_exception.message.value
              # Get the details map
              api_exception.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
              print "\n"
            end
          end
        # Check if the request returned an exception
        elsif action_handler.is_a? Variables::APIException
          exception = action_handler
          # Get the Code
          print 'code:'
          print exception.code.value
          # Get the Status
          print "\n status:"
          print exception.status.value
          # Get the Message
          print "\n message:"
          print exception.message.value
          # Get the details map
          exception.details.each do |k, v|
            print "\n"
            print k
            print v
            print "\n"
          end
          print "\n"
        end
      else
        response_object = response.data_object
        response_object.instance_variables.each do |field|
          print field
          print "\n"
          print response_object.instance_variable_get(field)
        end
      end
    end
  end
end
 
Get a Variable by its API Name
              
              
require 'ZOHOCRMSDK2_0'
class Variable
    def self.get_variable_for_api_name(variable_name)
    # """
    # This method is used to get the details of any specific variable with API Name
    # :param variable_api_name: The API name of the Variable to be obtained
    # """

    # """
    # example
    # variable_api_name = 'Variable55'
    # """
    # Get instance of VariablesOperations Class
    vo = Variables::VariablesOperations.new
    # Get instance of ParameterMap Class
    pm = ParameterMap.new
    # Possible parameters of Get Variable For API Name operation
    pm.add(Variables::VariablesOperations::GetVariableForAPINameParam.group, 'General')
    # Call get_variable_for_api_name method that takes ParameterMap instance and variable_api_name as parameters
    response = vo.get_variable_for_api_name(variable_name,pm)
    unless response.nil?
      status_code = response.status_code
      # Get the status code from response
      print "\n Status Code :" + status_code.to_s
      if [204, 304].include? status_code
        print(status_code == 204 ? 'No Content' : 'Not Modified')
        return
      end
      # Check if expected instance is received.
      if response.is_expected
        # Get object from response
        response_handler = response.data_object
        # Check if expected ResponseWrapper instance is received
        if response_handler.is_a? Variables::ResponseWrapper
          # Get the list of obtained Variable instances
          variables = response_handler.variables
          variables.each do |variable|
            # Get the APIName of each Variable
            print "\n Variable APIName: "
            print variable.api_name
            # Get the Name of each Variable
            print "\n Variable Name: "
            print variable.name
            # Get the Description of each Variable
            print "\n Variable Description: "
            print variable.description
            # Get the ID of each Variable
            print "\n Variable ID: "
            print variable.id.to_s
            # Get the Type of each Variable
            print "\n Variable Type: "
            print variable.type
            # Get the VariableGroup instance of each Variable
            variable_group = variable.variable_group
            unless variable_group.nil?
              # Get the APIName of the VariableGroup
              print "\n Variable VariableGroup APIName: "
              print variable_group.api_name
              # Get the ID of the VariableGroup
              print "\n Variable VariableGroup ID: "
              print variable_group.id.to_s
            end
            # Get the Value of each Variable
            print "\n Variable Value: "
            print variable.value
          end
        # Check if the request returned an exception
        elsif response_handler.is_a? Variables::APIException
          exception = response_handler
          # Get the Code
          print 'code:'
          print exception.code.value
          # Get the Status
          print "\n status:"
          print exception.status.value
          # Get the Message
          print "\n message:"
          print exception.message.value
          # Get the Details map
          exception.details.each do |k, v|
            print "\n"
            print k
            print v
            print "\n"
          end
          print "\n"
        end
      else
        response_object = response.data_object
        response_object.instance_variables.each do |field|
          print field
          print "\n"
          print response_object.instance_variable_get(field)
        end
      end
    end
  end
end
 
Update a Variable by its API Name
              
              
require 'ZOHOCRMSDK2_0'
class Variable
    def self.update_variable_for_api_name(variable_name)
    # """
    # This method is used to update details of a specific variable in CRM with API Name and print the response.
    # :param variable_api_name: The API name of the Variable to be updated
    # """

    # """
    # example
    # variable_api_name = 'Variable55'
    # """
    # Get instance of VariablesOperations Class
    vo = Variables::VariablesOperations.new
    # Get instance of BodyWrapper Class that will contain the request body
    bw = Variables::BodyWrapper.new
    # List to hold Variable instances
    variables = []
    # Get instance of Variable Class
    variable = Variables::Variable.new
    # Set the value
    variable.value = '45'
    # Add the variable instance to the array
    variables.push(variable)
    # Set the list to variables in BodyWrapper instance
    bw.variables = variables
    # Call update_variable_by_api_name method that takes BodyWrapper instance and variable_api_name as parameters
    response = vo.update_variable_by_api_name(variable_name,bw)
    unless response.nil?
      # Get the status code from response
      status_code = response.status_code
      print "\n Status Code :" + status_code.to_s
      # Check if expected instance is received.
      if response.is_expected
        # Get object from response
        action_handler = response.data_object
        # Check if expected ActionWrapper instance is received.
        if action_handler.is_a? Variables::ActionWrapper
          action_wrapper = action_handler
          # Get the list of obtained ActionResponse instances
          action_responses = action_wrapper.variables
          action_responses.each do |action_response|
            # Check if expected SuccessResponse instance is received.
            if action_response.is_a? Variables::SuccessResponse
              success_response = action_response
              # Get the Code
              print 'code:'
              print success_response.code.value
              # Get the Status
              print "\n status:"
              print success_response.status.value
              # Get the Message
              print "\n message:"
              print success_response.message.value
              success_response.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
            # Check if the request returned an exception
            elsif action_response.is_a? Variables::APIException
              api_exception = action_response
              # Get the Code
              print 'code:'
              print api_exception.code.value
              # Get the Status
              print "\n status:"
              print api_exception.status.value
              # Get the Message
              print "\n message:"
              print api_exception.message.value
              # Get the details map
              api_exception.details.each do |k, v|
                print "\n"
                print k
                print v
                print "\n"
              end
              print "\n"
            end
          end
        # Check if the request returned an exception
        elsif action_handler.is_a? Variables::APIException
          exception = action_handler
          # Get the Code
          print 'code:'
          print exception.code.value
          # Get the Status
          print "\n status:"
          print exception.status.value
          # Get the Message
          print "\n message:"
          print exception.message.value
          # Get the details map
          exception.details.each do |k, v|
            print "\n"
            print k
            print v
            print "\n"
          end
          print "\n"
        end
      else
        response_object = response.data_object
        response_object.instance_variables.each do |field|
          print field
          print "\n"
          print response_object.instance_variable_get(field)
        end
      end
    end
  end
end