def set_more_records(self, more_records):
"""
The method to set the value to more_records
Parameters:
more_records (bool) : A bool representing the more_records
"""
if more_records is not None and not isinstance(more_records, bool):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: more_records EXPECTED TYPE: bool', None,
None)
self.__more_records = more_records
self.__key_modified['more_records'] = 1
def set_connections(self, connections):
"""
The method to set the value to connections
Parameters:
connections (list) : An instance of list
"""
if connections is not None and not isinstance(connections, list):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: connections EXPECTED TYPE: list', None,
None)
self.__connections = connections
self.__key_modified['connections'] = 1
def set_canvas_width(self, canvas_width):
"""
The method to set the value to canvas_width
Parameters:
canvas_width (int) : An int representing the canvas_width
"""
if canvas_width is not None and not isinstance(canvas_width, int):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: canvas_width EXPECTED TYPE: int', None,
None)
self.__canvas_width = canvas_width
self.__key_modified['canvas_width'] = 1
def set_channel_expiry(self, channel_expiry): """ The method to set the value to channel_expiry Parameters: channel_expiry (datetime) : An instance of datetime """ from datetime import datetime if channel_expiry is not None and not isinstance(channel_expiry, datetime): raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: channel_expiry EXPECTED TYPE: datetime', None, None) self.__channel_expiry = channel_expiry self.__key_modified['channel_expiry'] = 1
def set_canvas_height(self, canvas_height):
"""
The method to set the value to canvas_height
Parameters:
canvas_height (int) : An int representing the canvas_height
"""
if canvas_height is not None and not isinstance(canvas_height, int):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: canvas_height EXPECTED TYPE: int', None,
None)
self.__canvas_height = canvas_height
self.__key_modified['canvas_height'] = 1
def set_message(self, message):
"""
The method to set the value to message
Parameters:
message (Choice) : An instance of Choice
"""
if message is not None and not isinstance(message, Choice):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: message EXPECTED TYPE: Choice', None,
None)
self.__message = message
self.__key_modified['message'] = 1
def set_display_label(self, display_label):
"""
The method to set the value to display_label
Parameters:
display_label (string) : A string representing the display_label
"""
if display_label is not None and not isinstance(display_label, str):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: display_label EXPECTED TYPE: str', None,
None)
self.__display_label = display_label
self.__key_modified['display_label'] = 1
def set_decimal_separator(self, decimal_separator):
"""
The method to set the value to decimal_separator
Parameters:
decimal_separator (string) : A string representing the decimal_separator
"""
if decimal_separator is not None and not isinstance(
decimal_separator, str):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: decimal_separator EXPECTED TYPE: str',
None, None)
self.add_key_value('decimal_separator', decimal_separator)
def set_download_url(self, download_url):
"""
The method to set the value to download_url
Parameters:
download_url (string) : A string representing the download_url
"""
if download_url is not None and not isinstance(download_url, str):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: download_url EXPECTED TYPE: str', None,
None)
self.__download_url = download_url
self.__key_modified['download_url'] = 1
def set_default_tab_group(self, default_tab_group):
"""
The method to set the value to default_tab_group
Parameters:
default_tab_group (string) : A string representing the default_tab_group
"""
if default_tab_group is not None and not isinstance(
default_tab_group, str):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: default_tab_group EXPECTED TYPE: str',
None, None)
self.add_key_value('default_tab_group', default_tab_group)
def set_sandboxdeveloper(self, sandboxdeveloper):
"""
The method to set the value to sandboxdeveloper
Parameters:
sandboxdeveloper (bool) : A bool representing the sandboxdeveloper
"""
if sandboxdeveloper is not None and not isinstance(
sandboxdeveloper, bool):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: sandboxdeveloper EXPECTED TYPE: bool',
None, None)
self.add_key_value('sandboxDeveloper', sandboxdeveloper)
def set_personal_account(self, personal_account):
"""
The method to set the value to personal_account
Parameters:
personal_account (bool) : A bool representing the personal_account
"""
if personal_account is not None and not isinstance(
personal_account, bool):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: personal_account EXPECTED TYPE: bool',
None, None)
self.add_key_value('personal_account', personal_account)
def set_sort_order_preference(self, sort_order_preference):
"""
The method to set the value to sort_order_preference
Parameters:
sort_order_preference (string) : A string representing the sort_order_preference
"""
if sort_order_preference is not None and not isinstance(
sort_order_preference, str):
raise SDKException(
Constants.DATA_TYPE_ERROR,
'KEY: sort_order_preference EXPECTED TYPE: str', None, None)
self.add_key_value('sort_order_preference', sort_order_preference)
def set_modified_time(self, modified_time): """ The method to set the value to modified_time Parameters: modified_time (datetime) : An instance of datetime """ from datetime import datetime if modified_time is not None and not isinstance(modified_time, datetime): raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: datetime', None, None) self.__modified_time = modified_time self.__key_modified['modified_time'] = 1
def set_include_child(self, include_child):
"""
The method to set the value to include_child
Parameters:
include_child (bool) : A bool representing the include_child
"""
if include_child is not None and not isinstance(include_child, bool):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: include_child EXPECTED TYPE: bool', None,
None)
self.__include_child = include_child
self.__key_modified['include_child'] = 1
def set_conflict_id(self, conflict_id):
"""
The method to set the value to conflict_id
Parameters:
conflict_id (string) : A string representing the conflict_id
"""
if conflict_id is not None and not isinstance(conflict_id, str):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: conflict_id EXPECTED TYPE: str', None,
None)
self.__conflict_id = conflict_id
self.__key_modified['conflict_id'] = 1
def set_blueprint(self, blueprint):
"""
The method to set the value to blueprint
Parameters:
blueprint (list) : An instance of list
"""
if blueprint is not None and not isinstance(blueprint, list):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: blueprint EXPECTED TYPE: list', None,
None)
self.__blueprint = blueprint
self.__key_modified['blueprint'] = 1
def set_visibility(self, visibility):
"""
The method to set the value to visibility
Parameters:
visibility (string) : A string representing the visibility
"""
if visibility is not None and not isinstance(visibility, str):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: visibility EXPECTED TYPE: str', None,
None)
self.__visibility = visibility
self.__key_modified['visibility'] = 1
def set_description(self, description):
"""
The method to set the value to description
Parameters:
description (string) : A string representing the description
"""
if description is not None and not isinstance(description, str):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: description EXPECTED TYPE: str', None,
None)
self.__description = description
self.__key_modified['description'] = 1
def set_file(self, file):
"""
The method to set the value to file
Parameters:
file (StreamWrapper) : An instance of StreamWrapper
"""
if file is not None and not isinstance(file, StreamWrapper):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: file EXPECTED TYPE: StreamWrapper', None,
None)
self.__file = file
self.__key_modified['file'] = 1
def set_currencies(self, currencies):
"""
The method to set the value to currencies
Parameters:
currencies (list) : An instance of list
"""
if currencies is not None and not isinstance(currencies, list):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: currencies EXPECTED TYPE: list', None,
None)
self.__currencies = currencies
self.__key_modified['currencies'] = 1
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 set_is_preview_available(self, is_preview_available):
"""
The method to set the value to is_preview_available
Parameters:
is_preview_available (bool) : A bool representing the is_preview_available
"""
if is_preview_available is not None and not isinstance(
is_preview_available, bool):
raise SDKException(
Constants.DATA_TYPE_ERROR,
'KEY: is_preview_available EXPECTED TYPE: bool', None, None)
self.__is_preview_available = is_preview_available
self.__key_modified['is_Preview_Available'] = 1
def set_original_size_byte(self, original_size_byte):
"""
The method to set the value to original_size_byte
Parameters:
original_size_byte (string) : A string representing the original_size_byte
"""
if original_size_byte is not None and not isinstance(
original_size_byte, str):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: original_size_byte EXPECTED TYPE: str',
None, None)
self.__original_size_byte = original_size_byte
self.__key_modified['original_Size_Byte'] = 1
def set_connectedlookup_apiname(self, connectedlookup_apiname):
"""
The method to set the value to connectedlookup_apiname
Parameters:
connectedlookup_apiname (string) : A string representing the connectedlookup_apiname
"""
if connectedlookup_apiname is not None and not isinstance(
connectedlookup_apiname, str):
raise SDKException(
Constants.DATA_TYPE_ERROR,
'KEY: connectedlookup_apiname EXPECTED TYPE: str', None, None)
self.__connectedlookup_apiname = connectedlookup_apiname
self.__key_modified['connectedlookup_apiname'] = 1
def set_parent_api_name(self, parent_api_name):
"""
The method to set the value to parent_api_name
Parameters:
parent_api_name (string) : A string representing the parent_api_name
"""
if parent_api_name is not None and not isinstance(
parent_api_name, str):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: parent_api_name EXPECTED TYPE: str', None,
None)
self.__parent_api_name = parent_api_name
self.__key_modified['parent_api_name'] = 1
def set_issubformsection(self, issubformsection):
"""
The method to set the value to issubformsection
Parameters:
issubformsection (bool) : A bool representing the issubformsection
"""
if issubformsection is not None and not isinstance(
issubformsection, bool):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: issubformsection EXPECTED TYPE: bool',
None, None)
self.__issubformsection = issubformsection
self.__key_modified['isSubformSection'] = 1
def set_sequence_number(self, sequence_number):
"""
The method to set the value to sequence_number
Parameters:
sequence_number (int) : An int representing the sequence_number
"""
if sequence_number is not None and not isinstance(
sequence_number, int):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: sequence_number EXPECTED TYPE: int', None,
None)
self.__sequence_number = sequence_number
self.__key_modified['sequence_number'] = 1
def set_group_operator(self, group_operator):
"""
The method to set the value to group_operator
Parameters:
group_operator (Choice) : An instance of Choice
"""
if group_operator is not None and not isinstance(
group_operator, Choice):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: group_operator EXPECTED TYPE: Choice',
None, None)
self.__group_operator = group_operator
self.__key_modified['group_operator'] = 1
def set_not_updated_count(self, not_updated_count):
"""
The method to set the value to not_updated_count
Parameters:
not_updated_count (int) : An int representing the not_updated_count
"""
if not_updated_count is not None and not isinstance(
not_updated_count, int):
raise SDKException(Constants.DATA_TYPE_ERROR,
'KEY: not_updated_count EXPECTED TYPE: int',
None, None)
self.__not_updated_count = not_updated_count
self.__key_modified['Not_Updated_Count'] = 1
