class GetNotificationDetailsParam(object):
page = Param('page',
'com.zoho.crm.api.Notification.GetNotificationDetailsParam')
per_page = Param(
'per_page',
'com.zoho.crm.api.Notification.GetNotificationDetailsParam')
channel_id = Param(
'channel_id',
'com.zoho.crm.api.Notification.GetNotificationDetailsParam')
module = Param(
'module', 'com.zoho.crm.api.Notification.GetNotificationDetailsParam')
class GetRecordParam(object):
approved = Param('approved', 'com.zoho.crm.api.Record.GetRecordParam')
converted = Param('converted', 'com.zoho.crm.api.Record.GetRecordParam')
cvid = Param('cvid', 'com.zoho.crm.api.Record.GetRecordParam')
uid = Param('uid', 'com.zoho.crm.api.Record.GetRecordParam')
fields = Param('fields', 'com.zoho.crm.api.Record.GetRecordParam')
startdatetime = Param('startDateTime', 'com.zoho.crm.api.Record.GetRecordParam')
enddatetime = Param('endDateTime', 'com.zoho.crm.api.Record.GetRecordParam')
territory_id = Param('territory_id', 'com.zoho.crm.api.Record.GetRecordParam')
include_child = Param('include_child', 'com.zoho.crm.api.Record.GetRecordParam')
def get_inventory_templates(self, param_instance=None):
"""
The method to get inventory templates
Parameters:
param_instance (ParameterMap) : An instance of ParameterMap
Returns:
APIResponse: An instance of APIResponse
Raises:
SDKException
"""
if param_instance is not None and not isinstance(
param_instance, ParameterMap):
raise SDKException(
Constants.DATA_TYPE_ERROR,
'KEY: param_instance EXPECTED TYPE: ParameterMap', None, None)
handler_instance = CommonAPIHandler()
api_path = ''
api_path = api_path + '/crm/v2.1/settings/inventory_templates'
handler_instance.set_api_path(api_path)
handler_instance.set_http_method(Constants.REQUEST_METHOD_GET)
handler_instance.set_category_method(Constants.REQUEST_CATEGORY_READ)
handler_instance.add_param(
Param(
'sort_by',
'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam'
), self.__sort_by)
handler_instance.add_param(
Param(
'sort_order',
'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam'
), self.__sort_order)
handler_instance.add_param(
Param(
'category',
'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam'
), self.__category)
handler_instance.set_param(param_instance)
try:
from zcrmsdk.src.com.zoho.crm.api.inventory_templates.response_handler import ResponseHandler
except Exception:
from .response_handler import ResponseHandler
return handler_instance.api_call(ResponseHandler.__module__,
'application/json')
def get_field(self, id):
"""
The method to get field
Parameters:
id (int) : An int representing the id
Returns:
APIResponse: An instance of APIResponse
Raises:
SDKException
"""
if not isinstance(id, int):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: id EXPECTED TYPE: int', None, None)
handler_instance = CommonAPIHandler()
api_path = ''
api_path = api_path + '/crm/v2.1/settings/fields/'
api_path = api_path + str(id)
handler_instance.set_api_path(api_path)
handler_instance.set_http_method(Constants.REQUEST_METHOD_GET)
handler_instance.set_category_method(Constants.REQUEST_CATEGORY_READ)
handler_instance.add_param(
Param('module', 'com.zoho.crm.api.Fields.GetFieldParam'),
self.__module)
try:
from zcrmsdk.src.com.zoho.crm.api.fields.response_handler import ResponseHandler
except Exception:
from .response_handler import ResponseHandler
return handler_instance.api_call(ResponseHandler.__module__,
'application/json')
def get_layouts(self):
"""
The method to get layouts
Returns:
APIResponse: An instance of APIResponse
Raises:
SDKException
"""
handler_instance = CommonAPIHandler()
api_path = ''
api_path = api_path + '/crm/v2.1/settings/layouts'
handler_instance.set_api_path(api_path)
handler_instance.set_http_method(Constants.REQUEST_METHOD_GET)
handler_instance.set_category_method(Constants.REQUEST_CATEGORY_READ)
handler_instance.add_param(
Param('module', 'com.zoho.crm.api.Layouts.GetLayoutsParam'),
self.__module)
try:
from zcrmsdk.src.com.zoho.crm.api.layouts.response_handler import ResponseHandler
except Exception:
from .response_handler import ResponseHandler
return handler_instance.api_call(ResponseHandler.__module__,
'application/json')
def get_field_attachments(self):
"""
The method to get field attachments
Returns:
APIResponse: An instance of APIResponse
Raises:
SDKException
"""
handler_instance = CommonAPIHandler()
api_path = ''
api_path = api_path + '/crm/v2.1/'
api_path = api_path + str(self.__module_api_name)
api_path = api_path + '/'
api_path = api_path + str(self.__record_id)
api_path = api_path + '/actions/download_fields_attachment'
handler_instance.set_api_path(api_path)
handler_instance.set_http_method(Constants.REQUEST_METHOD_GET)
handler_instance.set_category_method(Constants.REQUEST_CATEGORY_READ)
handler_instance.add_param(
Param(
'fields_attachment_id',
'com.zoho.crm.api.FieldAttachments.GetFieldAttachmentsParam'),
self.__fields_attachment_id)
try:
from zcrmsdk.src.com.zoho.crm.api.field_attachments.response_handler import ResponseHandler
except Exception:
from .response_handler import ResponseHandler
return handler_instance.api_call(ResponseHandler.__module__,
'application/x-download')
class SearchRecordsParam(object):
criteria = Param('criteria', 'com.zoho.crm.api.Record.SearchRecordsParam')
email = Param('email', 'com.zoho.crm.api.Record.SearchRecordsParam')
phone = Param('phone', 'com.zoho.crm.api.Record.SearchRecordsParam')
word = Param('word', 'com.zoho.crm.api.Record.SearchRecordsParam')
converted = Param('converted', 'com.zoho.crm.api.Record.SearchRecordsParam')
approved = Param('approved', 'com.zoho.crm.api.Record.SearchRecordsParam')
page = Param('page', 'com.zoho.crm.api.Record.SearchRecordsParam')
per_page = Param('per_page', 'com.zoho.crm.api.Record.SearchRecordsParam')
def update_pipeline(self, pipeline_id, request):
"""
The method to update pipeline
Parameters:
pipeline_id (int) : An int representing the pipeline_id
request (BodyWrapper) : An instance of BodyWrapper
Returns:
APIResponse: An instance of APIResponse
Raises:
SDKException
"""
try:
from zcrmsdk.src.com.zoho.crm.api.pipeline.body_wrapper import BodyWrapper
except Exception:
from .body_wrapper import BodyWrapper
if not isinstance(pipeline_id, int):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: pipeline_id EXPECTED TYPE: int', None,
None)
if request is not None and not isinstance(request, BodyWrapper):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: request EXPECTED TYPE: BodyWrapper', None,
None)
handler_instance = CommonAPIHandler()
api_path = ''
api_path = api_path + '/crm/v2.1/settings/pipeline/'
api_path = api_path + str(pipeline_id)
handler_instance.set_api_path(api_path)
handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT)
handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE)
handler_instance.set_content_type('application/json')
handler_instance.set_request(request)
handler_instance.add_param(
Param('layout_id',
'com.zoho.crm.api.Pipeline.UpdatePipelineParam'),
self.__layout_id)
try:
from zcrmsdk.src.com.zoho.crm.api.pipeline.action_handler import ActionHandler
except Exception:
from .action_handler import ActionHandler
return handler_instance.api_call(ActionHandler.__module__,
'application/json')
def transfer_and_delete(self, request):
"""
The method to transfer and delete
Parameters:
request (TransferAndDeleteWrapper) : An instance of TransferAndDeleteWrapper
Returns:
APIResponse: An instance of APIResponse
Raises:
SDKException
"""
try:
from zcrmsdk.src.com.zoho.crm.api.pipeline.transfer_and_delete_wrapper import TransferAndDeleteWrapper
except Exception:
from .transfer_and_delete_wrapper import TransferAndDeleteWrapper
if request is not None and not isinstance(request,
TransferAndDeleteWrapper):
raise SDKException(
Constants.DATA_TYPE_ERROR,
'KEY: request EXPECTED TYPE: TransferAndDeleteWrapper', None,
None)
handler_instance = CommonAPIHandler()
api_path = ''
api_path = api_path + '/crm/v2.1/settings/pipeline/actions/transfer'
handler_instance.set_api_path(api_path)
handler_instance.set_http_method(Constants.REQUEST_METHOD_POST)
handler_instance.set_category_method(Constants.REQUEST_CATEGORY_CREATE)
handler_instance.set_content_type('application/json')
handler_instance.set_request(request)
handler_instance.set_mandatory_checker(True)
handler_instance.add_param(
Param('layout_id',
'com.zoho.crm.api.Pipeline.TransferAndDeleteParam'),
self.__layout_id)
try:
from zcrmsdk.src.com.zoho.crm.api.pipeline.transfer_action_handler import TransferActionHandler
except Exception:
from .transfer_action_handler import TransferActionHandler
return handler_instance.api_call(TransferActionHandler.__module__,
'application/json')
class GetRecordsParam(object):
approved = Param('approved', 'com.zoho.crm.api.Record.GetRecordsParam')
converted = Param('converted', 'com.zoho.crm.api.Record.GetRecordsParam')
cvid = Param('cvid', 'com.zoho.crm.api.Record.GetRecordsParam')
ids = Param('ids', 'com.zoho.crm.api.Record.GetRecordsParam')
uid = Param('uid', 'com.zoho.crm.api.Record.GetRecordsParam')
fields = Param('fields', 'com.zoho.crm.api.Record.GetRecordsParam')
sort_by = Param('sort_by', 'com.zoho.crm.api.Record.GetRecordsParam')
sort_order = Param('sort_order', 'com.zoho.crm.api.Record.GetRecordsParam')
page = Param('page', 'com.zoho.crm.api.Record.GetRecordsParam')
per_page = Param('per_page', 'com.zoho.crm.api.Record.GetRecordsParam')
startdatetime = Param('startDateTime',
'com.zoho.crm.api.Record.GetRecordsParam')
enddatetime = Param('endDateTime',
'com.zoho.crm.api.Record.GetRecordsParam')
territory_id = Param('territory_id',
'com.zoho.crm.api.Record.GetRecordsParam')
include_child = Param('include_child',
'com.zoho.crm.api.Record.GetRecordsParam')
class DeleteRecordsParam(object):
ids = Param('ids', 'com.zoho.crm.api.Record.DeleteRecordsParam')
wf_trigger = Param('wf_trigger',
'com.zoho.crm.api.Record.DeleteRecordsParam')
class GetVariableForAPINameParam(object):
group = Param('group',
'com.zoho.crm.api.Variables.GetVariableForAPINameParam')
class DeleteRecordParam(object):
wf_trigger = Param('wf_trigger',
'com.zoho.crm.api.Record.DeleteRecordParam')
class RemoveTagsFromMultipleRecordsParam(object):
tag_names = Param('tag_names', 'com.zoho.crm.api.Tags.RemoveTagsFromMultipleRecordsParam')
ids = Param('ids', 'com.zoho.crm.api.Tags.RemoveTagsFromMultipleRecordsParam')
class GetVariableByIDParam(object):
group = Param('group', 'com.zoho.crm.api.Variables.GetVariableByIDParam')
class AddTagsToRecordParam(object):
tag_names = Param('tag_names', 'com.zoho.crm.api.Tags.AddTagsToRecordParam')
over_write = Param('over_write', 'com.zoho.crm.api.Tags.AddTagsToRecordParam')
class GetFieldsParam(object):
type = Param('type', 'com.zoho.crm.api.Fields.GetFieldsParam')
class GetRelatedRecordsParam(object):
page = Param('page',
'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam')
per_page = Param('per_page',
'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam')
class RemoveTagsFromRecordParam(object):
tag_names = Param('tag_names', 'com.zoho.crm.api.Tags.RemoveTagsFromRecordParam')
class DisableNotificationsParam(object):
channel_ids = Param('channel_ids', 'com.zoho.crm.api.Notification.DisableNotificationsParam')
class DeleteTaxesParam(object):
ids = Param('ids', 'com.zoho.crm.api.Taxes.DeleteTaxesParam')
class GetRecordCountForTagParam(object):
module = Param('module', 'com.zoho.crm.api.Tags.GetRecordCountForTagParam')
class GetDeletedRecordsParam(object):
type = Param('type', 'com.zoho.crm.api.Record.GetDeletedRecordsParam')
page = Param('page', 'com.zoho.crm.api.Record.GetDeletedRecordsParam')
per_page = Param('per_page',
'com.zoho.crm.api.Record.GetDeletedRecordsParam')
class DeleteContactRolesParam(object):
ids = Param('ids', 'com.zoho.crm.api.ContactRoles.DeleteContactRolesParam')
class GetMassUpdateStatusParam(object):
job_id = Param('job_id',
'com.zoho.crm.api.Record.GetMassUpdateStatusParam')
class DeleteVariablesParam(object):
ids = Param('ids', 'com.zoho.crm.api.Variables.DeleteVariablesParam')
class GetCustomViewsParam(object):
page = Param('page', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam')
per_page = Param('per_page',
'com.zoho.crm.api.CustomViews.GetCustomViewsParam')
class AddTagsToMultipleRecordsParam(object):
tag_names = Param('tag_names', 'com.zoho.crm.api.Tags.AddTagsToMultipleRecordsParam')
ids = Param('ids', 'com.zoho.crm.api.Tags.AddTagsToMultipleRecordsParam')
over_write = Param('over_write', 'com.zoho.crm.api.Tags.AddTagsToMultipleRecordsParam')
class DelinkRecordsParam(object):
ids = Param('ids', 'com.zoho.crm.api.RelatedRecords.DelinkRecordsParam')
class GetAssignmentRuleParam(object):
module = Param('module',
'com.zoho.crm.api.AssignmentRules.GetAssignmentRuleParam')
