def call():
log_instance = Logger.get_instance(
level=Logger.Levels.INFO,
file_path="/Users/user_name/Documents/python_sdk_log.log")
user = UserSignature(email="*****@*****.**")
token = OAuthToken(client_id="clientId",
client_secret="clientSecret",
token="REFRESH/ GRANT Token",
token_type=TokenType.REFRESH / TokenType.GRANT)
environment = USDataCenter.PRODUCTION()
store = FileStore(
file_path='/Users/username/Documents/python_sdk_tokens.txt')
resource_path = '/Users/user_name/Documents/python-app'
sdk_config = SDKConfig(auto_refresh_fields=True,
pick_list_validation=False)
Initializer.initialize(user, environment, token, store, sdk_config,
resource_path, log_instance)
module_1 = "Leads"
module_2 = "Contacts"
response_1 = RecordOperations().get_records(module_1)
response_2 = RecordOperations().get_records(module_2)
def initialize_sdk():
# Create an instance of Logger Class that takes two parameters
# 1 -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed.
# 2 -> Absolute file path, where messages need to be logged.
logger_instace = Logger.get_instance(
level=Logger.Levels.INFO,
file_path="/Users/user_name/Documents/python_sdk_log.log")
# Create an UserSignature instance that takes user Email as parameter
user = UserSignature(email="*****@*****.**")
"""
Create a Token instance that takes the following parameters
1 -> OAuth client id.
2 -> OAuth client secret.
3 -> OAuth redirect URL.
4 -> REFRESH/GRANT token.
5 -> token type.
"""
token = OAuthToken(client_id="clientId",
client_secret="clientSecret",
redirect_url="redirectURL",
token="REFRESH/ GRANT Token",
token_type=TokenType.REFRESH / TokenType.GRANT)
# Configure the environment
# which is of the pattern Domain.Environment
# Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
# Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
environment = USDataCenter.PRODUCTION()
# Create an instance of TokenStore
"""
Create an instance of TokenStore
1 -> Absolute file path of the file to persist tokens
"""
store = FileStore(
file_path='/Users/username/Documents/python_sdk_tokens.txt')
"""
Create an instance of SDKConfig
"""
config = SDKConfig(auto_refresh_fields=True,
pick_list_validation=False)
"""
The path containing the absolute directory path (in the key resource_path) to store user-specific files containing information about fields in modules.
"""
resource_path = '/Users/user_name/Documents/python-app'
"""
Call the static initialize method of Initializer class that takes the following arguments
1 -> UserSignature instance
2 -> Environment instance
3 -> Token instance
4 -> TokenStore instance
5 -> SDKConfig instance
6 -> resource_path
7 -> Logger instance
"""
Initializer.initialize(user, environment, token, store, config,
resource_path, logger_instace)
def call():
log_instance = Logger.get_instance(Logger.Levels.INFO,
"/Users/Documents/logs.txt")
user1 = UserSignature("*****@*****.**")
token1 = OAuthToken(client_id="clientId",
client_secret="clientSecret",
redirect_url="redirectURL",
refresh_token="refresh token")
environment = USDataCenter.PRODUCTION()
sdk_config_1 = SDKConfig(auto_refresh_fields=False,
pick_list_validation=True)
# store = DBStore(password='******')
store = FileStore("/Users/Documents/token.txt")
resource_path = '/Users/Documents/'
auto_refresh_fields = True
user1_module_api_name = 'Leads'
user2_module_api_name = 'Contacts'
user2 = UserSignature("*****@*****.**")
token2 = OAuthToken(client_id="clientId",
client_secret="clientSecret",
redirect_url="redirectURL",
refresh_token="refresh token")
proxy_user2 = RequestProxy('host', 8080)
sdk_config_2 = SDKConfig(auto_refresh_fields=True,
pick_list_validation=False)
Initializer.initialize(user1, environment, token1, store, sdk_config_1,
resource_path, log_instance)
t1 = MultiThread(environment, token1, user1, user1_module_api_name,
sdk_config_1)
t2 = MultiThread(environment, token2, user2, user2_module_api_name,
sdk_config_2, proxy_user2)
t1.start()
t2.start()
t1.join()
t2.join()
def initialize():
"""
Create an instance of Logger Class that takes two parameters
1 -> Level of the log messages to be logged. Can be configured by typing Logger.Levels "." and choose any level from the list displayed.
2 -> Absolute file path, where messages need to be logged.
"""
logger = Logger.get_instance(
level=Logger.Levels.INFO,
file_path=
'/home/simon/commerce_cube/ecom-ds-PropensityReporting/data/python_sdk_log.log'
)
# Create an UserSignature instance that takes user Email as parameter
user = UserSignature(email='*****@*****.**')
"""
Configure the environment
which is of the pattern Domain.Environment
Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
"""
environment = USDataCenter.PRODUCTION()
"""
Create a Token instance that takes the following parameters
1 -> OAuth client id.
2 -> OAuth client secret.
3 -> REFRESH/GRANT token.
4 -> token type.
5 -> OAuth redirect URL.
"""
token = OAuthToken(
client_id=os.getenv('zoho_client_id'),
client_secret=os.getenv('zoho_client_secret'),
token=
'1000.e9b9a622cb83e2861be87787bb4f03ec.0ae31e6e956acd0dbb4a6c6780f4971b',
token_type=TokenType.GRANT,
redirect_url='https://www.brightermonday.co.ke')
"""
Create an instance of TokenStore
1 -> Absolute file path of the file to persist tokens
"""
store = FileStore(
file_path=
'/home/simon/commerce_cube/ecom-ds-PropensityReporting/data/python_sdk_tokens.txt'
)
"""
Create an instance of TokenStore
1 -> DataBase host name. Default value "localhost"
2 -> DataBase name. Default value "zohooauth"
3 -> DataBase user name. Default value "root"
4 -> DataBase password. Default value ""
5 -> DataBase port number. Default value "3306"
"""
# store = DBStore()
# store = DBStore(host='host_name', database_name='database_name', user_name='user_name', password='******',port_number='port_number')
"""
auto_refresh_fields
if True - all the modules' fields will be auto-refreshed in the background, every hour.
if False - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler(zcrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py)
pick_list_validation
A boolean field that validates user input for a pick list field and allows or disallows the addition of a new value to the list.
if True - the SDK validates the input. If the value does not exist in the pick list, the SDK throws an error.
if False - the SDK does not validate the input and makes the API request with the user’s input to the pick list
"""
config = SDKConfig(auto_refresh_fields=True,
pick_list_validation=False)
"""
The path containing the absolute directory path (in the key resource_path) to store user-specific files containing information about fields in modules.
"""
resource_path = '/home/simon/commerce_cube/ecom-ds-PropensityReporting/data'
"""
Create an instance of RequestProxy class that takes the following parameters
1 -> Host
2 -> Port Number
3 -> User Name. Default value is None
4 -> Password. Default value is None
"""
# request_proxy = RequestProxy(host='proxyHost', port=8080)
# request_proxy = RequestProxy(host='proxyHost', port=8080, user='******', password='******')
"""
Call the static initialize method of Initializer class that takes the following arguments
1 -> UserSignature instance
2 -> Environment instance
3 -> Token instance
4 -> TokenStore instance
5 -> SDKConfig instance
6 -> resource_path
7 -> Logger instance. Default value is None
8 -> RequestProxy instance. Default value is None
"""
Initializer.initialize(user=user,
environment=environment,
token=token,
store=store,
sdk_config=config,
resource_path=resource_path,
logger=logger)
def get_custom_views(module_api_name):
"""
Create an instance of Logger Class that takes two parameters
1 -> Level of the log messages to be logged. Can be configured by typing Logger.Levels "." and choose any level from the list displayed.
2 -> Absolute file path, where messages need to be logged.
"""
logger = Logger.get_instance(
level=Logger.Levels.INFO,
file_path=
'/home/simon/commerce_cube/ecom-ds-PropensityReporting/data/python_sdk_log.log'
)
# Create an UserSignature instance that takes user Email as parameter
user = UserSignature(email='*****@*****.**')
"""
Configure the environment
which is of the pattern Domain.Environment
Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
"""
environment = USDataCenter.PRODUCTION()
"""
Create a Token instance that takes the following parameters
1 -> OAuth client id.
2 -> OAuth client secret.
3 -> REFRESH/GRANT token.
4 -> token type.
5 -> OAuth redirect URL.
"""
token = OAuthToken(
client_id=os.getenv('zoho_client_id'),
client_secret=os.getenv('zoho_client_secret'),
token=
'1000.4ceee886d212fe2f4bae575841b2d9d1.8716ba1d1d064921e67612fce4a1cc5b',
token_type=TokenType.GRANT,
redirect_url='https://www.brightermonday.co.ke')
"""
Create an instance of TokenStore
1 -> Absolute file path of the file to persist tokens
"""
store = FileStore(
file_path=
'/home/simon/commerce_cube/ecom-ds-PropensityReporting/data/python_sdk_tokens.txt'
)
"""
Create an instance of TokenStore
1 -> DataBase host name. Default value "localhost"
2 -> DataBase name. Default value "zohooauth"
3 -> DataBase user name. Default value "root"
4 -> DataBase password. Default value ""
5 -> DataBase port number. Default value "3306"
"""
# store = DBStore()
# store = DBStore(host='host_name', database_name='database_name', user_name='user_name', password='******',port_number='port_number')
"""
auto_refresh_fields
if True - all the modules' fields will be auto-refreshed in the background, every hour.
if False - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler(zcrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py)
pick_list_validation
A boolean field that validates user input for a pick list field and allows or disallows the addition of a new value to the list.
if True - the SDK validates the input. If the value does not exist in the pick list, the SDK throws an error.
if False - the SDK does not validate the input and makes the API request with the user’s input to the pick list
"""
config = SDKConfig(auto_refresh_fields=True,
pick_list_validation=False)
"""
The path containing the absolute directory path (in the key resource_path) to store user-specific files containing information about fields in modules.
"""
resource_path = '/home/simon/commerce_cube/ecom-ds-PropensityReporting/data'
"""
Create an instance of RequestProxy class that takes the following parameters
1 -> Host
2 -> Port Number
3 -> User Name. Default value is None
4 -> Password. Default value is None
"""
# request_proxy = RequestProxy(host='proxyHost', port=8080)
# request_proxy = RequestProxy(host='proxyHost', port=8080, user='******', password='******')
"""
Call the static initialize method of Initializer class that takes the following arguments
1 -> UserSignature instance
2 -> Environment instance
3 -> Token instance
4 -> TokenStore instance
5 -> SDKConfig instance
6 -> resource_path
7 -> Logger instance. Default value is None
8 -> RequestProxy instance. Default value is None
"""
Initializer.initialize(user=user,
environment=environment,
token=token,
store=store,
sdk_config=config,
resource_path=resource_path,
logger=logger)
"""
This method is used to get the custom views data of a particular module.
Specify the module name in your API request whose custom view data you want to retrieve.
:param module_api_name: the API name of the required module.
"""
"""
example
module_api_name = "Leads";
"""
# Get instance of CustomViewOperations Class that takes module_api_name as parameter
custom_views_operations = CustomViewsOperations(module_api_name)
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters of Get CustomViews operation
param_instance.add(GetCustomViewsParam.page, 1)
param_instance.add(GetCustomViewsParam.per_page, 20)
# Call get_custom_views method that takes ParameterMap instance as parameter
response = custom_views_operations.get_custom_views(param_instance)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
if response.get_status_code() in [204, 304]:
print('No Content' if response.get_status_code() ==
204 else 'Not Modified')
return
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected ResponseWrapper instance is received
if isinstance(response_object, ResponseWrapper):
# Get the list of obtained CustomView instances
custom_views_list = response_object.get_custom_views()
for custom_view in custom_views_list:
# Get the ID of each CustomView
print('CustomView ID: ' + str(custom_view.get_id()))
# Get the Name of each CustomView
print('CustomView Name: ' +
str(custom_view.get_name()))
# Get the System Name of each CustomView
print('CustomView System Name: ' +
str(custom_view.get_system_name()))
# Get the Category of each CustomView
print('CustomView Category: ' +
str(custom_view.get_category()))
# Get the DisplayValue of each CustomView
print('CustomView Display Value: ' +
str(custom_view.get_display_value()))
# Get the Offline value of each CustomView
print('CustomView Is offline: ' +
str(custom_view.get_offline()))
# Get the default value of each CustomView
print('CustomView Is default: ' +
str(custom_view.get_default()))
# Get the SystemDefined of each CustomView
print('CustomView Is System Defined: ' +
str(custom_view.get_system_defined()))
if custom_view.get_favorite() is not None:
# Get the Favorite of each CustomView
print('CustomView Favorite: ' +
str(custom_view.get_favorite()))
info = response_object.get_info()
if info is not None:
print("CustomView Info")
if info.get_per_page() is not None:
# Get the PerPage from Info
print('PerPage: ' + str(info.get_per_page()))
if info.get_page() is not None:
# Get the Page from Info
print('Page: ' + str(info.get_page()))
if info.get_more_records() is not None:
# Get the MoreRecords from Info
print('MoreRecords: ' +
str(info.get_more_records()))
if info.get_default() is not None:
# Get the Default from Info
print('Default: ' + info.get_default())
if info.get_count() is not None:
# Get the Count from Info
print('Count: ' + str(info.get_count()))
translation = info.get_translation()
if translation is not None:
print("Translation details")
# Get the PublicViews of the Translation
print('PublicViews: ' +
translation.get_public_views())
# Get the OtherUsersViews of the Translation
print('OtherUsersViews: ' +
translation.get_other_users_views())
# Get the SharedWithMe of the Translation
print('SharedWithMe: ' +
translation.get_shared_with_me())
# Get the CreatedByMe of the Translation
print('CreatedByMe: ' +
translation.get_created_by_me())
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " +
response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " +
response_object.get_message().get_value())
def download_result(job_id, destination_folder):
"""
Create an instance of Logger Class that takes two parameters
1 -> Level of the log messages to be logged. Can be configured by typing Logger.Levels "." and choose any level from the list displayed.
2 -> Absolute file path, where messages need to be logged.
"""
logger = Logger.get_instance(
level=Logger.Levels.INFO,
file_path=
'/home/simon/commerce_cube/ecom-ds-PropensityReporting/data/python_sdk_log.log'
)
# Create an UserSignature instance that takes user Email as parameter
user = UserSignature(email='*****@*****.**')
"""
Configure the environment
which is of the pattern Domain.Environment
Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
"""
environment = USDataCenter.PRODUCTION()
"""
Create a Token instance that takes the following parameters
1 -> OAuth client id.
2 -> OAuth client secret.
3 -> REFRESH/GRANT token.
4 -> token type.
5 -> OAuth redirect URL.
"""
token = OAuthToken(
client_id=os.getenv('zoho_client_id'),
client_secret=os.getenv('zoho_client_secret'),
token=
'1000.e9b9a622cb83e2861be87787bb4f03ec.0ae31e6e956acd0dbb4a6c6780f4971b',
token_type=TokenType.GRANT,
redirect_url='https://www.brightermonday.co.ke')
"""
Create an instance of TokenStore
1 -> Absolute file path of the file to persist tokens
"""
store = FileStore(
file_path=
'/home/simon/commerce_cube/ecom-ds-PropensityReporting/data/python_sdk_tokens.txt'
)
"""
Create an instance of TokenStore
1 -> DataBase host name. Default value "localhost"
2 -> DataBase name. Default value "zohooauth"
3 -> DataBase user name. Default value "root"
4 -> DataBase password. Default value ""
5 -> DataBase port number. Default value "3306"
"""
# store = DBStore()
# store = DBStore(host='host_name', database_name='database_name', user_name='user_name', password='******',port_number='port_number')
"""
auto_refresh_fields
if True - all the modules' fields will be auto-refreshed in the background, every hour.
if False - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler(zcrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py)
pick_list_validation
A boolean field that validates user input for a pick list field and allows or disallows the addition of a new value to the list.
if True - the SDK validates the input. If the value does not exist in the pick list, the SDK throws an error.
if False - the SDK does not validate the input and makes the API request with the user’s input to the pick list
"""
config = SDKConfig(auto_refresh_fields=True,
pick_list_validation=False)
"""
The path containing the absolute directory path (in the key resource_path) to store user-specific files containing information about fields in modules.
"""
resource_path = '/home/simon/commerce_cube/ecom-ds-PropensityReporting/data'
"""
Create an instance of RequestProxy class that takes the following parameters
1 -> Host
2 -> Port Number
3 -> User Name. Default value is None
4 -> Password. Default value is None
"""
# request_proxy = RequestProxy(host='proxyHost', port=8080)
# request_proxy = RequestProxy(host='proxyHost', port=8080, user='******', password='******')
"""
Call the static initialize method of Initializer class that takes the following arguments
1 -> UserSignature instance
2 -> Environment instance
3 -> Token instance
4 -> TokenStore instance
5 -> SDKConfig instance
6 -> resource_path
7 -> Logger instance. Default value is None
8 -> RequestProxy instance. Default value is None
"""
Initializer.initialize(user=user,
environment=environment,
token=token,
store=store,
sdk_config=config,
resource_path=resource_path,
logger=logger)
"""
This method is used to download the result of Bulk Read operation
:param job_id: The unique ID of the bulk read job.
:param destination_folder: The absolute path where downloaded file has to be stored.
"""
"""
example
job_id = 3409643000002461001
"""
# Get instance of BulkReadOperations Class
bulk_read_operations = BulkReadOperations()
# Call download_result method that takes job_id as parameter
response = bulk_read_operations.download_result(job_id)
if response is not None:
# Get the status code from response
print('Status Code: ' + str(response.get_status_code()))
if response.get_status_code() in [204, 304]:
print('No Content' if response.get_status_code() ==
204 else 'Not Modified')
return
# Get object from response
response_object = response.get_object()
if response_object is not None:
# Check if expected FileBodyWrapper instance is received.
if isinstance(response_object, FileBodyWrapper):
# Get StreamWrapper instance from the returned FileBodyWrapper instance
stream_wrapper = response_object.get_file()
# Construct the file name by joining the destinationFolder and the name from StreamWrapper instance
file_name = os.path.join(destination_folder,
stream_wrapper.get_name())
# Open the destination file where the file needs to be written in 'wb' mode
with open(file_name, 'wb') as f:
# Get the stream from StreamWrapper instance
for chunk in stream_wrapper.get_stream():
f.write(chunk)
f.close()
# Check if the request returned an exception
elif isinstance(response_object, APIException):
# Get the Status
print("Status: " +
response_object.get_status().get_value())
# Get the Code
print("Code: " + response_object.get_code().get_value())
print("Details")
# Get the details dict
details = response_object.get_details()
for key, value in details.items():
print(key + ' : ' + str(value))
# Get the Message
print("Message: " +
response_object.get_message().get_value())
def initialize():
"""
Create an instance of Logger Class that takes two parameters
1 -> Level of the log messages to be logged. Can be configured by typing Logger.Levels "." and choose any level from the list displayed.
2 -> Absolute file path, where messages need to be logged.
"""
logger = Logger.get_instance(
level=Logger.Levels.INFO,
file_path="/Users/user_name/Documents/python_sdk_log.log")
# Create an UserSignature instance that takes user Email as parameter
user = UserSignature(email="*****@*****.**")
"""
Configure the environment
which is of the pattern Domain.Environment
Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
"""
environment = USDataCenter.PRODUCTION()
"""
Create a Token instance that takes the following parameters
1 -> OAuth client id.
2 -> OAuth client secret.
3 -> OAuth redirect URL.
4 -> REFRESH/GRANT token.
5 -> token type.
"""
token = OAuthToken(client_id="clientId",
client_secret="clientSecret",
redirect_url="redirectURL",
token="REFRESH/ GRANT Token",
token_type=TokenType.REFRESH / TokenType.GRANT)
"""
Create an instance of TokenStore
1 -> Absolute file path of the file to persist tokens
"""
store = FileStore(
file_path='/Users/username/Documents/python_sdk_tokens.txt')
"""
Create an instance of TokenStore
1 -> DataBase host name. Default value "localhost"
2 -> DataBase name. Default value "zohooauth"
3 -> DataBase user name. Default value "root"
4 -> DataBase password. Default value ""
5 -> DataBase port number. Default value "3306"
"""
store = DBStore()
store = DBStore(host='host_name',
database_name='database_name',
user_name='user_name',
password='******',
port_number='port_number')
"""
A Boolean value for the key (auto_refresh_fields) to allow or prevent auto-refreshing of the modules' fields in the background.
if True - all the modules' fields will be auto-refreshed in the background whenever there is any change.
if False - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or the specific module's fields using methods from ModuleFieldsHandler
"""
auto_refresh_fields = True
"""
The path containing the absolute directory path (in the key resource_path) to store user-specific files containing information about fields in modules.
"""
resource_path = '/Users/user_name/Documents/python-app'
"""
Call the static initialize method of Initializer class that takes the following arguments
1 -> UserSignature instance
2 -> Environment instance
3 -> Token instance
4 -> TokenStore instance
5 -> Logger instance
6 -> auto_refresh_fields
7 -> resource_path
"""
Initializer.initialize(user=user,
environment=environment,
token=token,
store=store,
logger=logger,
auto_refresh_fields=auto_refresh_fields,
resource_path=resource_path)